Skip to content
Snippets Groups Projects
Commit ef0446b3 authored by Artur Sabirov's avatar Artur Sabirov Committed by Alexander Tolstoy
Browse files

chore: add merge request template for docs

parent af566614
No related branches found
No related tags found
1 merge request!221chore: add merge request template for docs
Pipeline #28298 passed
<!--
ШАБЛОН ОПИСАНИЯ MERGE REQUEST В РЕПОЗИТОРИИ picodata/picodata/docs
При копировании:
1. Удалить комментарии
2. Заменить курсивный текст шаблона своим в нормальном начертании
-->
## Задача
<!-- Также можно использовать слово *Проблема* -->
*Суть задачи — лаконично и ясно.*
<!--
ОПЦИОНАЛЬНО стоит указать:
* Кто поставил задачу?
* Если сам себе, то с кем это согласовано?
-->
## Решение
### Первая итерация
*Что было сделано — лаконично и ясно.*
<!-- Источники — ОПЦИОНАЛЬНО -->
See:
* *ссылка на источник*
* *ссылка на другой источник*
* *etc.*
<!-- Референсы — ОПЦИОНАЛЬНО -->
Refer:
* *ссылка на референс*
* *ссылка на другой референс*
* *etc.*
### Вторая итерация
*Эта и последующие итерации, если они потребуются, описываются по шаблону первой.*
<!-- Релевантный тикет (issue), если такой есть: -->
Close #*N*
<!-- где *N* — номер тикета, работа по которому закрывается текущим MR -->
## Ensure that:
* [ ] При оформлении MR и контента соблюден [стайлгайд](https://yt.picodata.io/articles/INT_PICODATA-A-21/Stil-napisaniya-dokumentov-Picodata-documentation-style-guide)
* [ ] Локальный сервер MkDocs запускается в строгом режиме (`mkdocs serve -s`)
* [ ] Контент отображается корректно
* [ ] Ссылки в контенте работоспособны и корректны
* [ ] Локальные ссылки в контенте заканчиваются расширением `.md`
<!-- Под контентом подразумеваются текст, изображения, таблицы, добавленные впервые или измененные в текущем MR -->
<!--
Замечания:
1. Название и описание MR — на *русском* языке. Как минимум до тех пор, пока не возникнет иная договоренность по используемым языкам
2. Предлагаю начинать нумерацию заголовков со второго уровня `##`, потому что заголовки первого уровня в GitLab сильно больше основного текста
3. Можно добавить источники и референсы в описание задачи, но не хочу перегружать шаблон
-->
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment