Регламент по заполнению bugажа знаний #
- Выбираем себе задачу из столбика “Открыто” на доске задач Creative.QA и согласовываем её выполнение с QA Team Lead.
- Убеждаемся, что у нас развернут bugаж знаний локально.
- Создаём новую ветку (branch) в git проекте. Для каждой задачи заводим новую ветку! В названии ветки указываем номер задачи из gitlab, чтобы проще было сопоставить задачу и ветку (также можно создать ветку из задачи нажав на кнопку “Create merge request”).
- Вносим все необходимые изменения в нашу ветку.
git commit -m "Кратко описываем изменения"(комитим изменения в локальную ветку).git push origin ваша-ветка(пушим изменения в удаленную ветку).- Делаем Merge request от вашей созданной ветки на ветку develop и выделяем пункт “не удалять ветку при слиянии”. И вешаем лейбл (метку) “На review и тест”
- Ждём подтверждение (appprove) или отправку на доработку от QA Team Lead или QA Engineer.
- После получения лейбла (метки) об успешной проверке изменения сливаются с веткой develop.
Слияние изменений в develop выполняет QA Team Lead.
Структура папок с контентом #
docs - здесь наши статьи.
posts - здесь наши новости.
images - сюда добавляем изображения, которые нам понадобятся в статьях.
Как добавить пункт в меню и заполнить статью #
-
Открываем папку
/content/docs/- здесь находятся наши статьи и из них автоматически генерируется меню. Можно посмотреть адрес текущего документа в адресной строке браузера (например, данная статья: /docs/luggage-of-knowledge/regulations/). -
Чтобы создать новый пункт меню создаём новую папку.
-
В новой папке создаём файл
_index.md- это наш пункт меню и одновременно статья. -
Заполняем его:
---
title: "Название статьи отображаемое в общем меню"
type: docs
weight: 22
// bookCollapseSection: true
---
Далее пойдёт ваш контент
weight: число - показывает насколько высоко будет новый раздел в общем списке, чем ближе число к 0, тем выше наш пункт
и учитывает только меню на том же уровне меню/подменю.
Контент, его можно обрамлять markdown тегами для создания заголовков,
выделения жирным и другого форматирования текста, а также использовать возможности страниц bugажа знаний.
Если нужно создать выпадающий список меню со множеством подпунктом, раcкомментируем строку bookCollapseSection: true.
- Чтобы создать подпункт:
В нашей новой папке создаём файл
your-file.mdи заполняем его аналогичным выше способом. Чтобы придумать название файла просто переводим названии раздела на английский и записываем в нижнем регистре через-.