Как участвовать в вики Голоса
Исходный текст
Исходный текст wiki находится на GitHub: https://github.com/GolosChain/wiki, основным языком разметки является markdown.
Вы можете сообщать о неточностях в issues, или предложить изменения с помощью Pull Request.
Рендеринг страниц wiki производится с помощью инструментария GitBook.
Участие в Вики Голоса с помощью github и gitbook.
Участвовать в вики Голоса можно несколькими разными способами. Подробно рассмотрим один из наиболее эффективных способов, который позволяет сразу предлагать новые статьи и вносить изменения в уже существующие статьи с помощью gitbook и pull request на github.
Создание аккаунта на Github и интеграция с Gitbook.
1. Прежде всего, вам нужно создать аккаунт на https://github.com.
2. После создания аккаунта заходим на страничку https://github.com/GolosChain/wiki и делаем форк репозитория вики. Для этого вам нужно нажать на кнопку Fork в правом верхнем углу и подождать несколько секунд, чтобы копия форка установилась в ваш гитхаб аккаунт. Скриншот:
3. Затем заходим на сайт на https://www.gitbook.com и авторизуемся там через гитхаб аккаунт. Скриншоты:
4. Теперь нужно сделать интеграцию, чтобы github и gitbook взаимодействовали друг с другом. В левом окне выбираем в качестве шаблона GITHUB, а в правом окне нажимаем на кнопку Install Github integration. Скриншот:
В следующем окне нужно указать репозиторий для установки в книгу Gitbook. Нажимаем на кнопку Only select repositories и в поле начинаем писать название репозитория вики Голоса. Для этого достаточно ввести первые 2-3 буквы (например wi) и сразу должен появится выбор для установки. Скриншот:
В нашем случае, это клон репозитория wiki. Нужно выбрать его и затем нажать на кнопку Install. Скриншот:
Если всё сделаете верно, то вас автоматически вернут на Гитхаб и наверху странички должно всплыть сообщение об успешной установке Gitbook. Скриншот:
Создание книги на Gitbook.
Теперь нужно создать новую книгу, с помощью которой можно будет делать новые статьи и правки в вики Голоса.
1. Заходим на сайт https://www.gitbook.com/ и в уже знакомом окне выбираем в левой части пункт GITHUB, а в правой части заполняем поля. В поле Title пишем любое название вашей книги (например: testviki, golosbook, viki-test и т.п.), в поле Description можно написать краткое описание вашей будущей книги (это не обязательно). Через менюшку Select a Repository выбираем форкнутый ранее клон вики и затем нажимаем на кнопку Create Book. Скриншот:
На следующей страничке нужно нажать на кнопку Continue editing и должен открыться интерфейс редактора вики Голоса. Скриншоты:
Примечание: Ваша книга будет доступна по ссылке: https://www.gitbook.com/book/имя_аккаунта_гитхаб/название_книги
2. Теперь вы можете добавлять новые статьи и делать правки уже существующих статей через интерфейс Gitbook.
Чтобы предложить новую статью в вики, нужно нажать в левой колонке на менюшку Add an article и заполнить поле Title с названием статьи. Ваша новая статья появится в левой колонке, нужно зайти в неё и приступить к написанию. Когда статья будет готова, нужно её опубликовать нажав кнопку Publish в правом верхнем углу.
Чтобы делать делать правки уже существующих статей - нужно выбрать любую статью из левой колонки, внести в неё изменения и нажать нажать на кнопку Publish.
Если нажать в левой колонке на вашу статью правой кнопкой мыши, то можно отредактировать её название или удалить статью полностью. Скриншот:
Создание запроса на изменение Вики Голоса.
Ну а теперь самое интересное. После того, как вы закончили свою статью или отредактировали уже имеющиеся, нужно создать новый pull request (запрос на изменения в вики). Для этого заходим снова на github в свой форк вики Голоса. Адрес страницы должен быть такого вида:
https://github.com/имя_вашего_аккаунта_гитхаб/wiki
Нажимаем на кнопку New pull request. Скриншот:
Откроется страница на которой будет видно, какие именно изменения вы предлагаете внести. Нажимаем на зелёную кнопку Create pull request, заполняем поле Article с названием вашего pull request (название должно как-то отражать тему вашей статьи), а в поле Write пишите комментарий к вашему pull request - о чём он и т.д. Затем нужно нажать на зеленую кнопку Create pull request и ваш pull request будет добавлен на рассмотрение. Скриншоты:
Когда ваш pull request будет рассмотрен командой goloscore - будет принято решение о внесении вашей статьи в вики Голоса или закрытии вашего pull request. На принятие решения может уйти несколько дней.
Примечание. Пока ваш pull request не получит статус merged ("слитый", "слившийся" - это означает, что он принят и ваша статья или правки вошли в Вики Голоса) или closed (закрытый) - не нужно создавать новые pull request*ы, ибо все последующие правки или новые статьи созданные через gitbook будут добавляться в виде commits в тот же самый pull request. То есть, в один и тот же pull request автоматически добавляются все последующие правки и статьи, пока он открыт и не слился (merged) с Вики Голоса.
commits - переводится как совершение, осуществление. В контексте Гитхаба это означает совершение каких-либо правок в коде, в статье и т.д.
Commit messages
По умолчанию gitbook сам генерирует commit messages. Если вы хотите писать их самостоятельно, в интерфейсе редактирования книги в правом нижнем углу надо нажать на "?" и зайти в Settings, там в разделе "git" можно отключить автоматический текст коммитов.
Альтернативный workflow
В связи с тем, что инструментарий gitbook недостаточно гибок и удобен (читайте подробно в статье Недостатки инструментария wiki Голоса или обзор gitbook), можно использовать более простой способ правки статей.
Встроенный редактор github
- Создаётся форк репозитория wiki на github
- Страницы редактируются непосредственно через встроенный редактор на github
Локальный редактор
- Создаётся форк репозитория wiki на github
- Форкнутый репо клонируется на локальную машину
- Статьи редактируются вашим любимым текстовым редактором. Имеет смысл использовать специализированные markdown-редакторы типа ghostwriter.
Обратная связь
- Почта [email protected]
- Группа в telegram: https://t.me/goloswikigroup
Баунти!
За участие в наполнении Вики Голоса вы можете получить поощрение.