Привет!
Что ж, пора переходить к практической части нашего docs-as-code путешествия! Всем удачи!
В начале повешу маленький дисклеймер: мы организуем только инструментальную часть docs as code, потому что процессы как правило подразумевают наличие команды. Так что процессуальную часть немного оставим в стороне — это касается вопросов ревью, синхронизации разработки документации с разработкой кода и т.д.
Ну, всё, поехали. Перед тем, как начать работу, настроим окружение.
1. Нам нужно установить python и git
Python — это язык программирования, нам он пригодится для установки и работы с генератором статических сайтов.
Git — это система контроля версий, в которой мы будем работать и хранить нашу документацию.
Скачайте дистрибутивы с официальных сайтов и установите их на компьютере: python; git
2. Нам нужно зарегистрировать аккаунт в github.
Сделать это можно на github.com (регистрация по кнопке Sign up в правом верхнем углу).
3. Для работы нам понадобится какой-нибудь текстовый редактор. Я настоятельно рекомендую использовать Visual Studio Code — это классический редактор кода с расширенными функциями, который удобно использовать для работы с облегченными языками разметки.
P.S. Если будут проблемы с установкой, пишите в комментарии к этому посту, попробуем разобраться.
#практика #docsascode
Что ж, пора переходить к практической части нашего docs-as-code путешествия! Всем удачи!
В начале повешу маленький дисклеймер: мы организуем только инструментальную часть docs as code, потому что процессы как правило подразумевают наличие команды. Так что процессуальную часть немного оставим в стороне — это касается вопросов ревью, синхронизации разработки документации с разработкой кода и т.д.
Ну, всё, поехали. Перед тем, как начать работу, настроим окружение.
1. Нам нужно установить python и git
Python — это язык программирования, нам он пригодится для установки и работы с генератором статических сайтов.
Git — это система контроля версий, в которой мы будем работать и хранить нашу документацию.
Скачайте дистрибутивы с официальных сайтов и установите их на компьютере: python; git
2. Нам нужно зарегистрировать аккаунт в github.
Сделать это можно на github.com (регистрация по кнопке Sign up в правом верхнем углу).
3. Для работы нам понадобится какой-нибудь текстовый редактор. Я настоятельно рекомендую использовать Visual Studio Code — это классический редактор кода с расширенными функциями, который удобно использовать для работы с облегченными языками разметки.
P.S. Если будут проблемы с установкой, пишите в комментарии к этому посту, попробуем разобраться.
#практика #docsascode