fox/CONTRIBUTING.md

Как внести изменения в документацию

Процесс внесения изменения в документацию состоит из шагов:

1. Создать ветку, в которой добавить новый контент или изменить существующий.
2. Создать запрос на слияние вашей ветки.
3. Запросить ревью изменений.
4. После согласования новой версии выполняется слияние вашей ветки с веткой main и релиз документации.

Слияние вашей ветки с веткой main и релиз документации выполняет ответственный за портал документации.

1 способ

Важно. Название ветки должно начинаться с префикса feature/. Это необходимо для публикации MR на тестовом стенде Vega для проведения ревью.

1. Перейдите в git-репозитории https://git.vimpelcom.ru/common/vega/beecloud-docs
2. Создайте отдельную ветку для внесения изменений:
   • в навигации перейдите в раздел </> Сode → Branches;
   • нажмите New branch;
   • заполните Branch name: feature/<имя ветки>;
   • выберите ветку-источник Create from: develop;
   • нажмите Create branch.
3. Перейдите в редактор md-файлов и внесите изменения в документацию. Рекомендуется использовать встроенный редактор Gitlab WEB Ide:
   • на странице вашей ветки нажмите Edit → WEB Ide;
   • редактор WEB Ide откроется в отдельной странице;
   • выберите раздел документации и внесите изменения;
   • сохраните изменения.
4. Отправьте изменения в репозиторий:
   • в WEB Ide перейдите раздел Source Control;
   • нажмите Commit to название ветки>;
   • нажмите Create MR в правом нижнем углу;
   • будет создан запрос на слияние и откроется страница New merge request;
   • укажите ревьюера, можно добавить несколько ревьюеров;
   • укажите метку Рецензия;
   • нажмите Create merge request.

Как определить, в какой файл проекта вносить изменения

1. Откройте портал документации https://console.cloud.dfcloud.ru/docs/.
2. Откройте нужный раздел портале.
3. В адресной строке посмотрите название html-файла. Например, https://console.cloud.dfcloud.ru/docs/guide/compute/compute-instructions/compute-servers-create.html.
4. Перейдите в WEB Ide и структуре проекта найдите md-файл. Например, compute-servers-create.html в структуре проекта расположен по пути guide/compute/compute-instructions/compute-servers-create.md.