Coder Social home page Coder Social logo

smart-notes-wiki's Introduction

smart notes wiki:

Мы ведём работу над базой знаний по ведению Smart Notes на платформе GitHub. База ведется в формате хранилища Obsidian, которое содержит файлы в разметке markdown.

Мы подготовили для вас инструкцию, как принять участие в создании и наполнении гайда даже если вам не знакомы необходимые технологии.

Добавление своих материалов в хранилище:

Самый простой способ разместить свои материалы в этой базе знаний — забросить их в редакцию в виде issue. Редакция свяжется с вами, уточнит необходимое, оформит и опубликует заметки в нужном формате.

Для того, чтобы пойти этим путём, необходимо:

  • Зарегистрироваться на платформе GitHub (если вы ещё этого не сделали)
  • Подтвердить учётную запись в письме от GitHub
  • Зайти в раздел Issues в репозитории smart-notes-wiki, нажать кнопку "New issue" и оформить свои мысли в произвольном виде заполнив поля Title и Leave comment. Далее следует нажать "Submit new issue"
  • Следить за письмами в вашей почте: когда редакция будет что-то комментировать в GitHub по вашей заявке — вам будут приходить письма.

Более сложный путь (для тех, кто умеет работать с Git и GitHub) — самостоятельно внести изменения в файлы хранилища и оформить Merge Request. На данном этапе развития гайда у нас нет специальных правил на именование веток или оформление заметок, главное — чтобы каждый файл хранилища содержал качественный и понятный текст, выражающий одну идею.

Редактирование существующих материалов хранилища:

Самый простой способ исправить опечатки — это отредактировать страницу непосредственно через платформу GitHub. Это требует от вас базовых навыков работы с GitHub и наличия учётной записи на этой платформе.

Другой способ (для тех, кто умеет работать с Git и GitHub) — самостоятельно внести изменения в файлы репозитория и оформить Merge Request.

Лицензия

Материалы текущего репозитория распространяются под лицензией Creative Commons Attribution-ShareAlike 4.0. В кратком пересказе вы можете:

  • Делиться (обмениваться) — копировать и распространять материал на любом носителе и в любом формате.
  • Адаптировать (создавать производные материалы) — делать ремиксы, видоизменять и создавать новое, опираясь на этот материал в любых целях, включая коммерческие.

При соблюдении следующих условий:

  • Вы должны обеспечить соответствующее указание авторства (или ссылку на источник), предоставить ссылку на лицензию, и обозначить изменения, если таковые были сделаны.
  • Если вы перерабатываете, преобразовываете материал или берёте его за основу для производного произведения, вы должны распространять переделанные вами части материала на условиях той же лицензии, в соответствии с которой распространяется оригинал.

Подробнее можно почитать тут

Коллектив авторов

Авторы:

  • Рустам Агамалиев (@rustamaga)
  • Иван Абашкин (@AbashkinIvan)

За помощь с советами и мотивацией спасибо:

  • Алексей Фёдоров (@fedorovpishet)
  • Юлия Багрий (@aviskase)

smart-notes-wiki's People

Contributors

avbikk avatar glader avatar hazgon avatar rustam-aka-rust avatar vital-k avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.