Переводим Lean DevOps

Сайт: https://leandevops.ru

Notion: https://leandevops.ru/notion

Как работать с репозиторием

• Коммиты напрямую в ветку main запрещены.
• Все сообщения к коммитам должны быть осмысленными, на русском языке.
• Для работы над переводом необходимо создать ветку с названием по шаблону: team<номер команды>/chapter<номер главы>. Например: team2/chapter3.
• Если вам так будет удобно, можете создавать ещё ветки, которые уже будут называться team<номер комады>/chapter<номер главы>/<что угодно>. Например, team4/chapter8/punctuation-correction. Все ветки такого типа сливаются в основную любым удобным вам способом (можно без пулл реквеста).
• Когда перевод очередной главы считается законченным, открывается пулл реквест по перенесению всех изменений в ветку main. Начинается стадия проверки. После проверки членом команды своей части перевода он одобряет изменения (ставит Approve на пулл реквесте). Когда вся глава считается проверенной, ветка вливается в main лидером команды.
• Все картинки располагаются в папке images внутри папки каждой главы. Названия файлов картинок должны быть осмысленными, на латинице или просто являться порядковым номером в главе.

Как собрать сайт локально

Как правило, в этом нет необходимости, но если вам хочется посмотреть, как ваш текст будет выглядеть на сайте, нужно сделать следующее:

1. Установить Hugo на свой компьютер: https://gohugo.io/installation/.

2. Открыть терминал и написать в корне проекта следующую команду:

   hugo serve --bind '0.0.0.0' -D --buildFuture
   

3. Перейти в браузере на 0.0.0.0:1313.

Более подробная инструкция есть на сайте Hugo: https://gohugo.io/getting-started/usage/.

Правила оформления Markdown

Это не ЯП, но всё же. Одинаковое оформление кода на протяжении всей книги значительно облегчит процесс проверки и гарантирует правильную обработку кода генератором сайта.

1. В коде не должны использоваться заголовки первого уровня вроде # Что-то там. Заголовок первого уровня — это название главы, он находится в хедере в поле title.

2. Для тире необходимо использовать 3 подряд идущих минуса ---.

3. Вокруг русских слов используются кавычки <<ёлочки>> как 2 знака меньше и больше. Вокруг английских слов "regular quots".

4. Как и в языках программирования будем использовать ограничение в 80 символов в строке. Если вы используете Visual Studio Code, установите расширение Rewrap, которое позволяет автоматически выравнивать текст в 80 символов при нажатии Alt + Q. В Vim можно выделить абзац и выровнять его с помощью vipgq.

5. При вставке ссылки необходимо обернуть её в треугольные скобки:

   <https://leandevops.ru>
   

6. В остальном будем следовать стилю, используемому в Google: https://google.github.io/styleguide/docguide/style.html. Следует обратить внимание на оформление списков.