Доброе утро!
Сегодня мы подготовим место для размещения исходных файлов нашей документации.
Так как для работы с докой мы используем систему контроля версий Git, то все исходники мы будем держать в гит-репозитории.
Гит — распределенная система управления версиями. Это значит, что проект хранится в удалённом хранилище на сервере, а программисты (и техписы) работают с локальными копиями хранилища у себя на устройствах и отправляют сделанные изменения на сервер для обновления оригинала проекта.
Такое хранилище и называется репозиторием.
Нам нужно создать гит-репозиторий, в котором мы разместим нашу документацию.
В этом нам поможет GitHub — самый популярный сервис для хранения версий проектов и работы с гитом.
Создать репозиторий просто:
1. Войдите в свой аккаунт GitHub;
2. В правом верхнем углу нажмите кнопку [+] и выберите пункт «New repository»;
3. Заполните поля в открывшейся форме:
✒️ Repository name — обязательное поле, название и slug вашего репозитория. Вы можете использовать латиницу, цифры и некоторые символы (точку, дефис и нижнее подчёркивание). Постарайтесь придумать название, которое будет отражать суть вашего репозитория. Мой, например, называется parawriter_docs;
✒️ Description — описание репозитория. Это поле необязательное, заполните его по своему усмотрению. Я ленивый, поэтому оставил описание пустым);
✒️ Public or Private. Публичный репозиторий будет виден всем пользователям Интернета (в режиме просмотра), а в приватном вы сами настраиваете список допущенных лиц. В рамках курса я рекомендую создать публичный репозиторий. Для этого выберите опцию Public;
✒️ Add a README file. Readme — это файл с описанием проекта. Я предлагаю добавить readme, потом мы зафиксируем в нём особенности работы с проектом. Активируйте этот чекбокс;
✒️ Add .gitignore. В файле .gitignore содержится список неотслеживаемых гитом файлов и папок. Нам это пока не нужно, оставьте чекбокс неактивным;
✒️Choose a license. Лицензии защищают наше авторское право на создаваемый в репозитории продукт. В рамках этого курса я предлагаю установить стандартную универсальную общественную лицензию, которая разрешает всем желающим пользоваться вашими наработками. Раскройте список и выберите GNU General Public License;
4. Нажмите кнопку Create repository.
Поздравляю! Вы создали репозиторий для вашей документации!
В следующем посте мы настроим локальную копию репозитория для удалённой работы с проектом.
P.S. Традиционно со всеми вопросами приходите в комментарии)
#практика #docsascode
Сегодня мы подготовим место для размещения исходных файлов нашей документации.
Так как для работы с докой мы используем систему контроля версий Git, то все исходники мы будем держать в гит-репозитории.
Гит — распределенная система управления версиями. Это значит, что проект хранится в удалённом хранилище на сервере, а программисты (и техписы) работают с локальными копиями хранилища у себя на устройствах и отправляют сделанные изменения на сервер для обновления оригинала проекта.
Такое хранилище и называется репозиторием.
Нам нужно создать гит-репозиторий, в котором мы разместим нашу документацию.
В этом нам поможет GitHub — самый популярный сервис для хранения версий проектов и работы с гитом.
Создать репозиторий просто:
1. Войдите в свой аккаунт GitHub;
2. В правом верхнем углу нажмите кнопку [+] и выберите пункт «New repository»;
3. Заполните поля в открывшейся форме:
✒️ Repository name — обязательное поле, название и slug вашего репозитория. Вы можете использовать латиницу, цифры и некоторые символы (точку, дефис и нижнее подчёркивание). Постарайтесь придумать название, которое будет отражать суть вашего репозитория. Мой, например, называется parawriter_docs;
✒️ Description — описание репозитория. Это поле необязательное, заполните его по своему усмотрению. Я ленивый, поэтому оставил описание пустым);
✒️ Public or Private. Публичный репозиторий будет виден всем пользователям Интернета (в режиме просмотра), а в приватном вы сами настраиваете список допущенных лиц. В рамках курса я рекомендую создать публичный репозиторий. Для этого выберите опцию Public;
✒️ Add a README file. Readme — это файл с описанием проекта. Я предлагаю добавить readme, потом мы зафиксируем в нём особенности работы с проектом. Активируйте этот чекбокс;
✒️ Add .gitignore. В файле .gitignore содержится список неотслеживаемых гитом файлов и папок. Нам это пока не нужно, оставьте чекбокс неактивным;
✒️Choose a license. Лицензии защищают наше авторское право на создаваемый в репозитории продукт. В рамках этого курса я предлагаю установить стандартную универсальную общественную лицензию, которая разрешает всем желающим пользоваться вашими наработками. Раскройте список и выберите GNU General Public License;
4. Нажмите кнопку Create repository.
Поздравляю! Вы создали репозиторий для вашей документации!
В следующем посте мы настроим локальную копию репозитория для удалённой работы с проектом.
P.S. Традиционно со всеми вопросами приходите в комментарии)
#практика #docsascode