Мы ведём работу над базой знаний по ведению 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)