Skip to content

YDBDOCS-1551-GUIDE-For-adding-content #28025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Nov 13, 2025
Merged

YDBDOCS-1551-GUIDE-For-adding-content #28025

merged 5 commits into from
Nov 13, 2025

Conversation

@SixOnMyface
Copy link
Contributor

@SixOnMyface SixOnMyface commented Oct 30, 2025

Changelog entry

CREATE GUIDE FOR A ADDING CONTENT TO PUBLIC MATERIALS

Changelog category

  • Documentation (changelog entry is not required)

@SixOnMyface SixOnMyface requested a review from a team as a code owner October 30, 2025 15:51
@github-actions
Copy link

github-actions bot commented Oct 30, 2025

Hi! Thank you for contributing!
The tests on this PR will run after a maintainer adds an ok-to-test label to this PR manually. Thank you for your patience!

@github-actions
Copy link

github-actions bot commented Oct 30, 2025

🟢 2025-10-30 15:54:14 UTC The validation of the Pull Request description is successful.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 30, 2025
@github-actions
Copy link

github-actions bot commented Oct 30, 2025

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ ENOENT: no such file or directory, open '/ru/contributor/documentation/guide-to-public-materials.md'

Warnings (13)

⚠️ Title not found: guide-to-public-materials.md in ru/contributor/documentation/index.md

⚠️ en/devops/observability/monitoring.md: 54: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 7]

⚠️ ru/devops/observability/monitoring.md: 72: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8]

⚠️ ru/public-materials/videos/2025.md: 25: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 39: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 45: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 59: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 71: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 7: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 9: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/reference/configuration/query_service_config.md: 33: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/yql/reference/syntax/insert_into.md: 65: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/yql/reference/syntax/update.md: 37: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

@github-actions
Copy link

github-actions bot commented Nov 5, 2025

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ Link is unreachable: ru/contributor/documentation/guide-to-public-materials.md in ru/contributor/documentation/index.md.

Warnings (20)

⚠️ Title not found: guide-to-public-materials.md in ru/contributor/documentation/index.md

⚠️ en/devops/observability/monitoring.md: 54: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 7]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 13: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 23: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 27: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 37: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 49: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 55: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 7: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/devops/observability/monitoring.md: 72: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8]

⚠️ ru/public-materials/videos/2025.md: 25: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 39: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 45: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 59: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 71: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Log was truncated. (5 records)

@github-actions
Copy link

github-actions bot commented Nov 5, 2025

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (19)

⚠️ en/devops/observability/monitoring.md: 54: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 7]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 13: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 23: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 27: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 37: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 49: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 55: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 7: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/devops/observability/monitoring.md: 72: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8]

⚠️ ru/public-materials/videos/2025.md: 25: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 39: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 45: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 59: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 71: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 7: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Log was truncated. (4 records)

orange13
orange13 reviewed Nov 6, 2025
View reviewed changes
ydb/docs/ru/core/contributor/documentation/guide-to-public-material.md Outdated

### Тег

У каждого видео должен быть свой [тег](../../public-materials/videos.md), отражающий категорию и краткое содержание. Все виды тегов расписаны в `/public-materials/_includes/tags.md`. Тег ставится следующим после названия.
Copy link
Contributor

@orange13 orange13 Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Давай здесь ссылку дадим? Можно на https://ydb.tech/docs/ru/public-materials/videos

Copy link
Contributor Author

@SixOnMyface SixOnMyface Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Так как я дал уже ссылку чуть выше, решил немного поменять формулировку и убрать ссылку из первого предложения.

orange13
orange13 reviewed Nov 6, 2025
View reviewed changes
ydb/docs/ru/core/contributor/documentation/guide-to-public-material.md Outdated

Ссылки на видео оформляются по стандартным md-правилам. `@[название_ресурса](ссылка)`. Например:

- `@[youtube](https://youtu.be/Dy0VtzQatag?list=PL6Wui14DvQPwuUE1tijVmiBSl2LCLH3ru)`
Copy link
Contributor

@orange13 orange13 Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Давай приведём здесь все используемые варианты (rutube/Яндекс видео)

И для ссылки на youtube здесь list=*** лишнее

@github-actions
Copy link

github-actions bot commented Nov 7, 2025

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (21)

⚠️ en/devops/observability/monitoring.md: 54: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 7]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 13: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 23: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 27: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 38: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 40: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 46: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 58: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 64: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 7: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/devops/observability/monitoring.md: 72: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8]

⚠️ ru/public-materials/videos/2025.md: 25: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 39: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 45: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 59: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Log was truncated. (6 records)

fomichev3000
fomichev3000 previously approved these changes Nov 12, 2025
View reviewed changes
ydb/docs/ru/core/contributor/documentation/guide-to-public-material.md Outdated

### Целевая аудитория

Обязательно следующий абзац должен быть про целевую аудиторию публикуемого видео. Учитывайте их конкретную роль ([разработчики приложений](../../dev/index.md), [DevOps-инженеры](../../dev/index.md), [инженеры по безопасности](../../security/index.md) и т.д.), а если вы не можете сориентироваться самостоятельно, то можно снова спросить совета у ИИ. Тот, скорее всего, не ошибется.
Copy link
Member

@fomichev3000 fomichev3000 Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Может у автора спросить?

Copy link
Contributor

@orange13 orange13 Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Исправили

@github-actions
Copy link

github-actions bot commented Nov 13, 2025

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (21)

⚠️ en/devops/observability/monitoring.md: 54: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 7]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 13: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 23: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 27: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 38: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 40: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 46: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 58: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 64: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/contributor/documentation/guide-to-public-material.md: 7: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/devops/observability/monitoring.md: 72: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8]

⚠️ ru/public-materials/videos/2025.md: 25: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 39: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 45: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/public-materials/videos/2025.md: 59: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Log was truncated. (6 records)

@orange13 orange13 enabled auto-merge (squash) November 13, 2025 07:10
@orange13 orange13 added the ok-to-test Special label used to approve a PR for testing on our infrastructure label Nov 13, 2025
@github-actions github-actions bot removed the ok-to-test Special label used to approve a PR for testing on our infrastructure label Nov 13, 2025
@github-actions
Copy link

github-actions bot commented Nov 13, 2025 •
edited
Loading

⚪ 2025-11-13 07:47:58 UTC Pre-commit check linux-x86_64-release-asan for 4e680d1 has started.
⚪ 2025-11-13 07:48:02 UTC Artifacts will be uploaded here
⚪ 2025-11-13 07:49:24 UTC ya make is running...
🟢 2025-11-13 07:49:31 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-11-13 07:49:42 UTC Build successful.

@github-actions
Copy link

github-actions bot commented Nov 13, 2025 •
edited
Loading

⚪ 2025-11-13 07:48:57 UTC Pre-commit check linux-x86_64-relwithdebinfo for 4e680d1 has started.
⚪ 2025-11-13 07:49:15 UTC Artifacts will be uploaded here
⚪ 2025-11-13 07:51:39 UTC ya make is running...
🟢 2025-11-13 07:51:46 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-11-13 07:51:51 UTC Build successful.

@orange13 orange13 merged commit 869046a into ydb-platform:main Nov 13, 2025
19 of 22 checks passed
github-actions bot pushed a commit that referenced this pull request Nov 13, 2025
@SixOnMyface @github-actions
YDBDOCS-1551-GUIDE-For-adding-content (#28025)
6cfbcb5 
Co-authored-by: Stepan Beloyarov <beloyarovstep@yandex-team.ru>
(cherry picked from commit 869046a)
@ydbot
Copy link
Collaborator

ydbot commented Nov 13, 2025

Successfully created backport PR for stable-25-2:

@ydbot ydbot mentioned this pull request Nov 13, 2025
Merged
@ydbot
Copy link
Collaborator

ydbot commented Nov 13, 2025

Successfully created backport PR for stable-25-3:

github-actions bot pushed a commit that referenced this pull request Nov 13, 2025
@SixOnMyface @github-actions
YDBDOCS-1551-GUIDE-For-adding-content (#28025)
3c02262 
Co-authored-by: Stepan Beloyarov <beloyarovstep@yandex-team.ru>
(cherry picked from commit 869046a)
@ydbot ydbot mentioned this pull request Nov 13, 2025
Merged
maybenotilya pushed a commit to maybenotilya/ydb that referenced this pull request Nov 15, 2025
@SixOnMyface @maybenotilya
YDBDOCS-1551-GUIDE-For-adding-content (ydb-platform#28025)
525d929 
Co-authored-by: Stepan Beloyarov <beloyarovstep@yandex-team.ru>
qyryq pushed a commit to qyryq/ydb that referenced this pull request Nov 24, 2025
@SixOnMyface @qyryq
YDBDOCS-1551-GUIDE-For-adding-content (ydb-platform#28025)
1ad6e78 
Co-authored-by: Stepan Beloyarov <beloyarovstep@yandex-team.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@orange13 orange13 orange13 approved these changes

@fomichev3000 fomichev3000 fomichev3000 left review comments

Assignees

No one assigned

Labels

backport/stable-25-2 backport/stable-25-3 documentation Improvements or additions to documentation external

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@SixOnMyface @ydbot @fomichev3000 @orange13