Skip to content

Commit 2f218e1

Browse files
authored
[docs] update review.md with details about backports (#20142)
1 parent 60e65a0 commit 2f218e1

File tree

2 files changed

+24
-0
lines changed
  • ydb/docs

2 files changed

+24
-0
lines changed

ydb/docs/en/core/contributor/documentation/review.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ Building on the high-level overview in [{#T}](index.md), this article dives deep
5454

5555
## Checklist {#checklist}
5656

57+
### If the PR is new content for the main branch
58+
5759
- [ ] The text is understandable for the article's target audience.
5860
- [ ] The text is technically accurate.
5961
- [ ] The text is grammatically correct, with no punctuation, spelling, or typographical errors.
@@ -72,6 +74,16 @@ This checklist is a condensed version of [{#T}](style-guide.md) and serves as a
7274

7375
{% endnote %}
7476

77+
### If the PR is a backport to a stable branch
78+
79+
The documentation content is independently published on the website from multiple Git branches. Similar to source code development, `main` is the documentation for upcoming releases, while the documentation for each specific {{ ydb-short-name }} release is published from a stable branch. For example, {{ ydb-short-name }} v25.1 corresponds to the `stable-25-1` branch. If the documentation content needs to be cherry-picked from `main` to a stable branch, a separate PR is created with `stable-***` as the target branch. The review process for such PRs is different, as the content has already been reviewed when it was merged into `main`. Use the following checklist instead:
80+
81+
- [ ] The backport PR mentions identifiers or links to one or more PRs where this content was introduced in the `main` branch.
82+
- [ ] The content of the backport PR matches the original PRs to `main`. The content has been correctly moved if there was a structural refactoring between branches.
83+
- [ ] The PR compiles correctly, the preview generates without errors or warnings, and the content appears in the correct locations.
84+
- [ ] There are no merge artifacts such as duplicate content, `>>>>>>>>`-like Git markers, or similar issues.
85+
- [ ] The feature appears to be available in the corresponding {{ ydb-short-name }} release. Double-check with the author or feature owner if unsure.
86+
7587
## What documentation review is not
7688

7789
### Testing

ydb/docs/ru/core/contributor/documentation/review.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@
5454

5555
## Контрольный список {#checklist}
5656

57+
### Если PR добавляет новый контент в ветку main
58+
5759
- [ ] Текст понятен целевой аудитории статьи.
5860
- [ ] Текст технически точен.
5961
- [ ] Текст грамматически правильный, без пунктуационных, орфографических или типографских ошибок.
@@ -72,6 +74,16 @@
7274

7375
{% endnote %}
7476

77+
### Если PR является обратным переносом в стабильную ветку
78+
79+
Содержимое документации публикуется на сайте из нескольких Git-веток независимо. Аналогично разработке исходного кода, ветка `main` содержит документацию для будущих релизов, а документация для каждого конкретного выпуска {{ ydb-short-name }} публикуется из стабильной ветки. Например, версии {{ ydb-short-name }} v25.1 соответствует ветка `stable-25-1`. Если необходимо перенести документацию из ветки `main` в стабильную ветку через cherry-pick, создаётся отдельный PR с целевой веткой `stable-***`. Процесс проверки таких PR отличается, так как содержимое уже прошло ревью при слиянии в ветку `main`. В таком случае используйте следующий чек-лист:
80+
81+
- [ ] В PR для обратного переноса указаны идентификаторы или ссылки на один или несколько PR, в которых данный контент был добавлен в ветку `main`.
82+
- [ ] Содержимое PR для обратного переноса совпадает с оригинальными PR в ветку `main`. Если структура документации была изменена, содержимое перенесено корректно.
83+
- [ ] PR корректно собирается, предварительный просмотр формируется без ошибок и предупреждений, контент отображается в правильных местах.
84+
- [ ] Отсутствуют артефакты слияния, такие как дублирующийся контент, Git-маркеры типа `>>>>>>>>` и другие аналогичные проблемы.
85+
- [ ] Функциональность, описанная в документации, доступна в соответствующем релизе {{ ydb-short-name }}. В случае сомнений уточните у автора или ответственного за эту функциональность.
86+
7587
## Чем не является ревью документации
7688

7789
### Тестирование

0 commit comments

Comments
 (0)