Редактирование документации

Вся эта документация состоит из Markdown файлов и картинок. При изменении в репозитории это всё собираются в сайт, который вы сейчас это читаете.

Подготовка

Hugo позволяет вам построить этот сайт прямо на localhost.

1. Установите Hugo
2. Установите Git

Вам необходимо сделать fork репозитория. И клонировать fork себе на компьютер.

git clone [email protected]:BLABLA/podkop-wiki.git

Работа с Hugo

Перейдите в директорию с репозиторием и выполните

hugo server -D

Hugo построил сайт и теперь он в реальном времени подтягивает все изменения, которые вы будете делать в файлах. В браузере откройте http://localhost:1313/

Перейдите в content/docs и попробуйте изменить любую страницу и посмотреть на изменения.

Требования к тексту и картинкам

Опирайтесь на структуру, которая есть сейчас. Орфографию и пунктуацию проверяйте через Орфограммку (платно) или ChatGPT (бесплатно) и другие инструменты.

Имя картинок должны иметь только строчные буквы, слова разделяются с помощью -.

Скриншоты необходимо делать только нужной части, а не всего рабочего стола.

Влить ваши изменения

После того как вы внесли всё, что хотели проверили это на ошибки, вам необходимо запушить их в свой форк. И после этого в интерфейсе GitHub нажать кнопку Create Pull Request.

PR будет создан в основном репозитории. После рассмотрения:

1. Вы сделали всё идеально, и он будет сразу влит
2. Вы допустили ошибки или неточности. Вас попросят это исправить. Для исправления снова редактируйте свой форк, пушите, и изменения придут в уже созданный PR.
3. Вы написали какую-то дичь/допустили большое количество ошибок/поломали сайт. В этом случае PR будет закрыт.