Skip to content

PHP & Rust SDK docs alignment#37673

Merged
sintjuri merged 2 commits intomainfrom
sdk_docs_alignment
Apr 13, 2026
Merged

PHP & Rust SDK docs alignment#37673
sintjuri merged 2 commits intomainfrom
sdk_docs_alignment

Conversation

@vgvoleg
Copy link
Copy Markdown
Collaborator

@vgvoleg vgvoleg commented Apr 8, 2026

Changelog entry

...

Changelog category

  • Documentation (changelog entry is not required)

Description for reviewers

...

Copilot AI review requested due to automatic review settings April 8, 2026 13:17
@vgvoleg vgvoleg requested a review from a team as a code owner April 8, 2026 13:17
@ydbot
Copy link
Copy Markdown
Collaborator

ydbot commented Apr 8, 2026

Run Extra Tests

Run additional tests for this PR. You can customize:

  • Test Size: small, medium, large (default: all)
  • Test Targets: any directory path (default: ydb/)
  • Sanitizers: ASAN, MSAN, TSAN
  • Coredumps: enable for debugging (default: off)
  • Additional args: custom ya make arguments

▶  Run tests

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

2026-04-08 13:25:07 UTC Pre-commit check linux-x86_64-release-asan for ed177f2 has started.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

2026-04-08 13:25:32 UTC Pre-commit check linux-x86_64-relwithdebinfo for ed177f2 has started.
2026-04-08 13:25:36 UTC Artifacts will be uploaded here
2026-04-08 13:27:02 UTC ya make is running...
🟢 2026-04-08 13:27:08 UTC Tests successful.

Ya make output | Test bloat

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

🟢 2026-04-08 13:27:11 UTC Build successful.

Copy link
Copy Markdown
Contributor

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

Note

Copilot was unable to run its full agentic suite in this review.

This PR aligns the RU SDK documentation to consistently include Rust and PHP across reference pages and recipes, adding code examples where available and explicitly marking unsupported functionality.

Changes:

  • Added Rust/PHP tabs (often “not supported yet”) across Topic/HealthCheck/reference pages and multiple recipes.
  • Added concrete Rust/PHP code examples for several areas (coordination, upsert, retry, bulk upsert, auth).
  • Reordered / adjusted some SDK install and debugging sections for consistency.

Reviewed changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
ydb/docs/ru/core/reference/ydb-sdk/topic.md Adds Rust/PHP tabs throughout Topic docs (mostly “not supported”).
ydb/docs/ru/core/reference/ydb-sdk/health-check-api.md Removes Go tab and adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/reference/ydb-sdk/coordination.md Adds detailed Rust coordination guidance + code examples; PHP marked unsupported.
ydb/docs/ru/core/reference/ydb-sdk/_includes/install.md Reorders PHP install tab (moved below Rust).
ydb/docs/ru/core/recipes/ydb-sdk/vector-search.md Adds Rust/PHP “not supported” tabs across the recipe.
ydb/docs/ru/core/recipes/ydb-sdk/upsert.md Adds Rust and PHP UPSERT examples.
ydb/docs/ru/core/recipes/ydb-sdk/session-pool-limit.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/retry.md Adds Rust and PHP retry guidance + examples.
ydb/docs/ru/core/recipes/ydb-sdk/init.md Moves Rust init snippet into the main tab list order.
ydb/docs/ru/core/recipes/ydb-sdk/distributed-lock.md Adds Rust distributed lock example; PHP marked unsupported.
ydb/docs/ru/core/recipes/ydb-sdk/debug-prometheus.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/debug-otel.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/debug-logs.md Adds Rust logging guidance; reorders Python/JS blocks; keeps PHP logging section.
ydb/docs/ru/core/recipes/ydb-sdk/debug-jaeger.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/bulk-upsert.md Normalizes whitespace in Java snippets; adds Rust/PHP bulk upsert examples.
ydb/docs/ru/core/recipes/ydb-sdk/balancing-random-choice.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/balancing-prefer-pile.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/balancing-prefer-location.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/balancing-prefer-local.md Adds Rust/PHP “not supported” tabs.
ydb/docs/ru/core/recipes/ydb-sdk/auth-static.md Adds Rust static-credentials example.
ydb/docs/ru/core/recipes/ydb-sdk/auth-service-account.md Adds Rust service-account auth example.
ydb/docs/ru/core/recipes/ydb-sdk/auth-metadata.md Adds Rust metadata-credentials example.
ydb/docs/ru/core/recipes/ydb-sdk/auth-env.md Adds Rust “from env” credentials example.
ydb/docs/ru/core/recipes/ydb-sdk/auth-anonymous.md Adds Rust anonymous auth example.
ydb/docs/ru/core/recipes/ydb-sdk/auth-access-token.md Adds Rust access-token auth example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@vgvoleg vgvoleg force-pushed the sdk_docs_alignment branch from cf2c13a to 9ae802b Compare April 8, 2026 13:39
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

2026-04-08 13:51:57 UTC Pre-commit check linux-x86_64-release-asan for bd3e1a3 has started.
2026-04-08 13:52:01 UTC Artifacts will be uploaded here
2026-04-08 13:53:39 UTC ya make is running...
🟢 2026-04-08 13:53:45 UTC Tests successful.

Ya make output | Test bloat

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

🟢 2026-04-08 13:53:49 UTC Build successful.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 8, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

2026-04-08 14:02:12 UTC Pre-commit check linux-x86_64-relwithdebinfo for bd3e1a3 has started.
2026-04-08 14:02:16 UTC Artifacts will be uploaded here
2026-04-08 14:03:55 UTC ya make is running...
🟢 2026-04-08 14:04:01 UTC Tests successful.

Ya make output | Test bloat

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

🟢 2026-04-08 14:04:04 UTC Build successful.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ Link is unreachable: ru/_includes/feature-not-supported.md in ru/reference/ydb-sdk/health-check-api.md.

Warnings (9)

⚠️ Skip error: SkippedEvalError: Cannot apply an unsupported filter: ansible_config_file | dirname

⚠️ Variable ansible_config_file | dirname not found in en/devops/deployment-options/ansible/initial-deployment/deployment-configuration-v1.md

⚠️ Variable ansible_config_file | dirname not found in ru/devops/deployment-options/ansible/initial-deployment/deployment-configuration-v1.md

⚠️ en/reference/languages-and-apis/jdbc-driver/properties.md: 28: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/dev/resource-consumption-management.md: 235: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- WmPoolId (Utf8) - Иденти..."]

⚠️ ru/dev/resource-consumption-management.md: 241: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- NONE - Не обрабатывается."]

⚠️ ru/dev/system-views.md: 278: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "* .sys/query_sessions — соде..."]

⚠️ ru/dev/system-views.md: 302: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- NONE - Не обрабатывается."]

⚠️ ru/dev/system-views.md: 308: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- IDLE - Сессия ожидает запр..."]

@vgvoleg vgvoleg force-pushed the sdk_docs_alignment branch from 9ae802b to 91c739a Compare April 8, 2026 16:26
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

2026-04-08 16:28:01 UTC Pre-commit check linux-x86_64-release-asan for 63c67da has started.
2026-04-08 16:28:19 UTC Artifacts will be uploaded here
2026-04-08 16:30:31 UTC ya make is running...
🟢 2026-04-08 16:30:37 UTC Tests successful.

Ya make output | Test bloat

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

🟢 2026-04-08 16:30:40 UTC Build successful.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

2026-04-08 16:29:03 UTC Pre-commit check linux-x86_64-relwithdebinfo for 63c67da has started.
2026-04-08 16:29:39 UTC Artifacts will be uploaded here
2026-04-08 16:31:43 UTC ya make is running...
🟢 2026-04-08 16:31:48 UTC Tests successful.

Ya make output | Test bloat

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

🟢 2026-04-08 16:31:52 UTC Build successful.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (9)

⚠️ Skip error: SkippedEvalError: Cannot apply an unsupported filter: ansible_config_file | dirname

⚠️ Variable ansible_config_file | dirname not found in en/devops/deployment-options/ansible/initial-deployment/deployment-configuration-v1.md

⚠️ Variable ansible_config_file | dirname not found in ru/devops/deployment-options/ansible/initial-deployment/deployment-configuration-v1.md

⚠️ en/reference/languages-and-apis/jdbc-driver/properties.md: 28: MD009 / no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

⚠️ ru/dev/resource-consumption-management.md: 235: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- WmPoolId (Utf8) - Иденти..."]

⚠️ ru/dev/resource-consumption-management.md: 241: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- NONE - Не обрабатывается."]

⚠️ ru/dev/system-views.md: 278: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "* .sys/query_sessions — соде..."]

⚠️ ru/dev/system-views.md: 302: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- NONE - Не обрабатывается."]

⚠️ ru/dev/system-views.md: 308: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- IDLE - Сессия ожидает запр..."]

asmyasnikov
asmyasnikov previously approved these changes Apr 8, 2026
sintjuri
sintjuri previously approved these changes Apr 10, 2026
fomichev3000
fomichev3000 previously approved these changes Apr 11, 2026
@vgvoleg vgvoleg dismissed stale reviews from fomichev3000, sintjuri, and asmyasnikov via 908bfc1 April 13, 2026 17:31
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 13, 2026

2026-04-13 17:33:17 UTC Pre-commit check linux-x86_64-relwithdebinfo for 09eb7a0 has started.
2026-04-13 17:33:36 UTC Artifacts will be uploaded here
2026-04-13 17:36:07 UTC ya make is running...
🟢 2026-04-13 17:36:13 UTC Tests successful.

Ya make output | Test bloat

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

🟢 2026-04-13 17:36:16 UTC Build successful.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 13, 2026

2026-04-13 17:33:44 UTC Pre-commit check linux-x86_64-release-asan for 09eb7a0 has started.
2026-04-13 17:34:10 UTC Artifacts will be uploaded here
2026-04-13 17:35:30 UTC ya make is running...
🟢 2026-04-13 17:35:36 UTC Tests successful.

Ya make output | Test bloat

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

🟢 2026-04-13 17:35:39 UTC Build successful.

@github-actions
Copy link
Copy Markdown

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (8)

⚠️ Skip error: SkippedEvalError: Cannot apply an unsupported filter: ansible_config_file | dirname

⚠️ Variable ansible_config_file | dirname not found in en/devops/deployment-options/ansible/initial-deployment/deployment-configuration-v1.md

⚠️ Variable ansible_config_file | dirname not found in ru/devops/deployment-options/ansible/initial-deployment/deployment-configuration-v1.md

⚠️ ru/dev/vector-indexes.md: 143: MD051 / link-fragments Link fragments should be valid [Context: "запросах на выборку"]

⚠️ ru/dev/vector-indexes.md: 145: MD024 / no-duplicate-heading Multiple headings with the same content [Context: "Виды векторных индексов {#type..."]

⚠️ ru/public-materials/videos/2025.md: 323: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "* как значительно улучшить про..."]

⚠️ ru/recipes/ydb-sdk/vector-search.md: 1233: YFM005 / tab-list-not-closed Tab list not closed [Context: "{% list tabs %}"]

⚠️ ru/recipes/ydb-sdk/vector-search.md: 1299: YFM005 / tab-list-not-closed Tab list not closed [Context: " {% list tabs %}"]

@sintjuri sintjuri merged commit b8030bc into main Apr 13, 2026
10 checks passed
@sintjuri sintjuri deleted the sdk_docs_alignment branch April 13, 2026 18:22
@ydbot
Copy link
Copy Markdown
Collaborator

ydbot commented Apr 13, 2026

Backport

To backport this PR, click the button next to the target branch and then click "Run workflow" in the Run Actions UI.

Branch Run
stable-25-4, stable-25-4-1, stable-26-1, stable-26-1-1 ▶  Backport
stable-26-1, stable-26-1-1 ▶  Backport
stable-26-1 ▶  Backport

▶  Backport manual

@ydbot
Copy link
Copy Markdown
Collaborator

ydbot commented Apr 13, 2026

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.

6 participants