Skip to content

[docs] translate config v2 and other DevOps-related content #18927

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.

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

Merged
merged 17 commits into from
Jun 23, 2025

Conversation

blinkov
Copy link
Member

@blinkov blinkov commented May 28, 2025

Changelog entry

...

Changelog category

  • Documentation (changelog entry is not required)

Description for reviewers

...

@blinkov blinkov requested a review from a team as a code owner May 28, 2025 06:57
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 28, 2025
Copy link

github-actions bot commented May 28, 2025

🟢 2025-05-28 15:02:05 UTC The validation of the Pull Request description is successful.

Copy link

github-actions bot commented May 28, 2025

2025-05-28 07:03:56 UTC Pre-commit check linux-x86_64-release-asan for f7578ee has started.
2025-05-28 07:04:07 UTC Artifacts will be uploaded here
2025-05-28 07:06:29 UTC ya make is running...
🟢 2025-05-28 07:06:35 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-28 07:06:41 UTC Build successful.
2025-05-28 07:06:45 UTC Check cancelled

Copy link

github-actions bot commented May 28, 2025

2025-05-28 07:04:38 UTC Pre-commit check linux-x86_64-relwithdebinfo for f7578ee has started.
2025-05-28 07:04:49 UTC Artifacts will be uploaded here
2025-05-28 07:06:55 UTC Check cancelled

@ydbot
Copy link
Collaborator

ydbot commented May 28, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

Copy link

github-actions bot commented May 28, 2025

2025-05-28 07:10:47 UTC Pre-commit check linux-x86_64-relwithdebinfo for 0dc1441 has started.
2025-05-28 07:10:58 UTC Artifacts will be uploaded here
2025-05-28 07:13:15 UTC ya make is running...
🟢 2025-05-28 07:13:21 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-28 07:13:26 UTC Build successful.

Copy link

github-actions bot commented May 28, 2025

2025-05-28 07:10:48 UTC Pre-commit check linux-x86_64-release-asan for 0dc1441 has started.
2025-05-28 07:11:00 UTC Artifacts will be uploaded here
2025-05-28 07:13:27 UTC ya make is running...
🟢 2025-05-28 07:13:33 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-28 07:13:40 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@blinkov blinkov assigned anton-bobkov and unassigned ElenaAfina May 28, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 28, 2025
@ydbot
Copy link
Collaborator

ydbot commented May 29, 2025

Hey @anton-bobkov, it has been 30 business-hours since the author's last update, could you please review?

Copy link

github-actions bot commented May 30, 2025

2025-05-30 13:40:46 UTC Pre-commit check linux-x86_64-relwithdebinfo for 824f3e9 has started.
2025-05-30 13:41:09 UTC Artifacts will be uploaded here
2025-05-30 13:44:01 UTC ya make is running...
🟢 2025-05-30 13:44:07 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-30 13:44:13 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented May 30, 2025

🔄 New commits pushed — @anton-bobkov please take a look.

Copy link

github-actions bot commented May 30, 2025

2025-05-30 13:43:27 UTC Pre-commit check linux-x86_64-release-asan for 824f3e9 has started.
2025-05-30 13:43:38 UTC Artifacts will be uploaded here
2025-05-30 13:46:00 UTC ya make is running...
🟢 2025-05-30 13:46:06 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-30 13:46:12 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@ydbot
Copy link
Collaborator

ydbot commented Jun 2, 2025

Hey @anton-bobkov, it has been 84 business-hours since the author's last update, could you please review?

@anton-bobkov anton-bobkov requested a review from Copilot June 3, 2025 08:25
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds new and updated English documentation for configuration V2 and various DevOps-related topics, aligning links and placeholders with the current directory structure and improving consistency across guides.

  • Introduces a guide to check configuration mechanism versions (V1 vs V2) and a note recommending V2 for new clusters.
  • Adds procedures for replacing node FQDN, enabling node authentication/authorization, and backup-and-recovery overlays.
  • Updates DevOps concept pages (versioning, system requirements, maintenance without downtime, federated query) and standardizes link paths and section titles in changelogs and contributor docs.

Reviewed Changes

Copilot reviewed 158 out of 158 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
ydb/docs/en/core/devops/configuration-management/check-config-version.md New guide for checking configuration version (V1/V2)
ydb/docs/en/core/devops/configuration-management/_includes/replacing-nodes.md Added FQDN replacement procedure
ydb/docs/en/core/devops/configuration-management/_includes/node-authorization.md New node authentication and authorization guide
ydb/docs/en/core/devops/configuration-management/_includes/configuration-version-note.md Added tip recommending migration to configuration V2
ydb/docs/en/core/devops/concepts/versioning.md Added versioning overview with BNF grammar
ydb/docs/en/core/devops/concepts/toc_p.yaml Populated DevOps concepts table of contents
ydb/docs/en/core/devops/concepts/system-requirements.md Added hardware and software requirements
ydb/docs/en/core/devops/concepts/maintenance-without-downtime.md Added maintenance without downtime concept
ydb/docs/en/core/devops/concepts/index.md Created DevOps concepts index
ydb/docs/en/core/devops/backup-and-recovery.md Added backup and recovery guide with CLI and S3 sections
ydb/docs/en/core/devops/ansible/observability/index.md Removed outdated Ansible observability section
ydb/docs/en/core/devops/_includes/backup_and_recovery/options_overlay.md Added backup overlay options
ydb/docs/en/core/contributor/manage-releases.md Standardized section titles and updated upgrade links
ydb/docs/en/core/concepts/federated_query/architecture.md Updated federated query connector links
ydb/docs/en/core/concepts/federated_query/_includes/connector_deployment.md Corrected connector deployment link path
ydb/docs/en/core/changelog-server.md Updated changelog links for federated queries, decommissioning, and maintenance task priorities
Comments suppressed due to low confidence (2)

ydb/docs/en/core/changelog-server.md:92

  • [nitpick] The link includes the .md extension, whereas other changelog links omit it. Consider dropping the extension for consistency.
* Published [documentation](./devops/deployment-options/manual/federated-queries/connector-deployment.md) on deploying YDB with [federated query]...

ydb/docs/en/core/changelog-server.md:121

  • [nitpick] This link also includes .md—consider removing the extension to match the style of other in-page links.
* Enhanced the PDisk page with [attributes](...), and a button to initiate [disk decommissioning](./devops/deployment-options/manual/decommissioning.md).

@ydbot
Copy link
Collaborator

ydbot commented Jun 4, 2025

Hey @anton-bobkov, it has been 114 business-hours since the author's last update, could you please review?

@ydbot
Copy link
Collaborator

ydbot commented Jun 5, 2025

Hey @anton-bobkov, it has been 144 business-hours since the author's last update, could you please review?

…version.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

github-actions bot commented Jun 6, 2025

2025-06-06 08:27:01 UTC Pre-commit check linux-x86_64-relwithdebinfo for 932c766 has started.
2025-06-06 08:27:12 UTC Artifacts will be uploaded here
2025-06-06 08:29:37 UTC ya make is running...
🟢 2025-06-06 08:29:43 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-06 08:29:50 UTC Build successful.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 01:12:05 UTC Pre-commit check linux-x86_64-relwithdebinfo for 14dc555 has started.
2025-06-23 01:12:58 UTC Check cancelled

@ydbot
Copy link
Collaborator

ydbot commented Jun 23, 2025

🔄 New commits pushed — @anton-bobkov please take a look.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 01:12:49 UTC Pre-commit check linux-x86_64-release-asan for 14dc555 has started.
2025-06-23 01:12:52 UTC Check cancelled

@ydbot
Copy link
Collaborator

ydbot commented Jun 23, 2025

🔄 New commits pushed — @anton-bobkov please take a look.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 01:13:38 UTC Pre-commit check linux-x86_64-relwithdebinfo for db9ac23 has started.
2025-06-23 01:13:58 UTC Artifacts will be uploaded here
2025-06-23 01:16:24 UTC Check cancelled

Co-authored-by: anton-bobkov <anton-bobkov@yandex-team.ru>
@blinkov blinkov enabled auto-merge (squash) June 23, 2025 01:16
@ydbot
Copy link
Collaborator

ydbot commented Jun 23, 2025

🔄 New commits pushed — @anton-bobkov please take a look.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 01:20:10 UTC Pre-commit check linux-x86_64-relwithdebinfo for fb84887 has started.
2025-06-23 01:20:22 UTC Artifacts will be uploaded here
2025-06-23 01:22:50 UTC ya make is running...
🟢 2025-06-23 01:22:56 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-23 01:23:02 UTC Build successful.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 01:20:23 UTC Pre-commit check linux-x86_64-release-asan for fb84887 has started.
2025-06-23 01:20:34 UTC Artifacts will be uploaded here
2025-06-23 01:23:03 UTC ya make is running...
🟢 2025-06-23 01:23:09 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-23 01:23:15 UTC Build successful.

Copy link

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ ENOENT: no such file or directory, open '/en/devops/_includes/storage-device-requirements.md'

Warnings (2)

⚠️ Title not found: ../../concepts/system-requirements.md in en/devops/deployment-options/manual/initial-deployment.md

⚠️ Title not found: ./system-requirements.md in en/devops/concepts/index.md

@ydbot
Copy link
Collaborator

ydbot commented Jun 23, 2025

🔄 New commits pushed — @anton-bobkov please take a look.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 01:42:45 UTC Pre-commit check linux-x86_64-release-asan for 67001d1 has started.
2025-06-23 01:42:57 UTC Artifacts will be uploaded here
2025-06-23 01:45:27 UTC ya make is running...
🟢 2025-06-23 01:45:33 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-23 01:45:39 UTC Build successful.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 01:42:51 UTC Pre-commit check linux-x86_64-relwithdebinfo for 67001d1 has started.
2025-06-23 01:43:03 UTC Artifacts will be uploaded here
2025-06-23 01:45:27 UTC ya make is running...
🟢 2025-06-23 01:45:33 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-23 01:45:40 UTC Build successful.

Copy link

❌ Documentation build

Revision build failed

Build logs

Errors (2)

❌ ENOENT: no such file or directory, open '/_includes/storage-device-requirements.md'

❌ ENOENT: no such file or directory, open '/en/devops/_includes/storage-device-requirements.md'

Warnings (3)

⚠️ Title not found: ../../concepts/system-requirements.md in en/devops/deployment-options/manual/initial-deployment.md

⚠️ Title not found: ../../deployment-options/kubernetes/initial-deployment.md in en/devops/configuration-management/configuration-v2/config-overview.md

⚠️ Title not found: ./system-requirements.md in en/devops/concepts/index.md

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 02:11:04 UTC Pre-commit check linux-x86_64-release-asan for 717aade has started.
2025-06-23 02:11:11 UTC Artifacts will be uploaded here
2025-06-23 02:13:41 UTC ya make is running...
🟢 2025-06-23 02:13:47 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-23 02:13:53 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented Jun 23, 2025

🔄 New commits pushed — @anton-bobkov please take a look.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 02:14:09 UTC Pre-commit check linux-x86_64-relwithdebinfo for 717aade has started.
2025-06-23 02:14:20 UTC Artifacts will be uploaded here
2025-06-23 02:16:43 UTC ya make is running...
🟢 2025-06-23 02:16:49 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-23 02:16:56 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@blinkov blinkov merged commit 7e24464 into main Jun 23, 2025
13 checks passed
blinkov added a commit that referenced this pull request Jun 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants