Skip to content

Add documentation on using Dev Container for contributors to YDB SDKs #20039

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

polRk
Copy link
Member

@polRk polRk commented Jun 23, 2025

Changelog category

  • Documentation (changelog entry is not required)

@polRk polRk requested a review from a team as a code owner June 23, 2025 10:43
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 23, 2025
Copy link

🟢 2025-06-23 10:47:16 UTC The validation of the Pull Request description is successful.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 10:47:46 UTC Pre-commit check linux-x86_64-relwithdebinfo for 526699e has started.
2025-06-23 10:47:57 UTC Artifacts will be uploaded here
2025-06-23 10:50:18 UTC ya make is running...
🟢 2025-06-23 10:50:24 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 10:50:31 UTC Build successful.

Copy link

github-actions bot commented Jun 23, 2025

2025-06-23 10:47:51 UTC Pre-commit check linux-x86_64-release-asan for 526699e has started.
2025-06-23 10:48:03 UTC Artifacts will be uploaded here
2025-06-23 10:50:39 UTC ya make is running...
🟢 2025-06-23 10:50: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 10:50:54 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@ydbot
Copy link
Collaborator

ydbot commented Jun 24, 2025

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

@ydbot
Copy link
Collaborator

ydbot commented Jun 25, 2025

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

@ydbot
Copy link
Collaborator

ydbot commented Jun 26, 2025

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

Copy link

github-actions bot commented Jun 26, 2025

2025-06-26 07:55:17 UTC Pre-commit check linux-x86_64-relwithdebinfo for 7a4afe6 has started.
2025-06-26 07:55:28 UTC Artifacts will be uploaded here
2025-06-26 07:57:50 UTC ya make is running...
🟢 2025-06-26 07:57:55 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-26 07:58:01 UTC Build successful.

Copy link

github-actions bot commented Jun 26, 2025

2025-06-26 07:57:43 UTC Pre-commit check linux-x86_64-release-asan for 7a4afe6 has started.
2025-06-26 07:57:54 UTC Artifacts will be uploaded here
2025-06-26 08:00:25 UTC ya make is running...
🟢 2025-06-26 08:00:30 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-26 08:00:36 UTC Build successful.

@polRk polRk requested a review from ElenaAfina June 27, 2025 08:26
@ydbot
Copy link
Collaborator

ydbot commented Jun 27, 2025

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

Copy link

github-actions bot commented Jun 27, 2025

2025-06-27 08:30:27 UTC Pre-commit check linux-x86_64-relwithdebinfo for 6ead22d has started.
2025-06-27 08:30:39 UTC Artifacts will be uploaded here
2025-06-27 08:33:03 UTC ya make is running...
🟢 2025-06-27 08:33: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-27 08:33:15 UTC Build successful.

Copy link

github-actions bot commented Jun 27, 2025

2025-06-27 08:30:40 UTC Pre-commit check linux-x86_64-release-asan for 6ead22d has started.
2025-06-27 08:30:51 UTC Artifacts will be uploaded here
2025-06-27 08:33:14 UTC ya make is running...
🟢 2025-06-27 08:33:20 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-27 08:33:26 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (16)

⚠️ en/contributor/devcontainer/index.md: 24: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Java SDK"]

⚠️ en/contributor/devcontainer/index.md: 25: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 29: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Go SDK"]

⚠️ en/contributor/devcontainer/index.md: 30: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 35: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### JavaScript/TypeScript SDK"]

⚠️ en/contributor/devcontainer/index.md: 36: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 41: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Python SDK (PR #590)"]

⚠️ en/contributor/devcontainer/index.md: 42: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ ru/contributor/devcontainer/index.md: 24: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Java SDK"]

⚠️ ru/contributor/devcontainer/index.md: 25: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 29: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Go SDK"]

⚠️ ru/contributor/devcontainer/index.md: 30: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 35: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### JavaScript/TypeScript SDK"]

⚠️ ru/contributor/devcontainer/index.md: 36: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 41: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Python SDK (PR #590)"]

Log was truncated. (1 records)

### Java SDK
- В [`devcontainer`](https://github.com/ydb-platform/ydb-java-sdk/tree/master/.devcontainer) есть `Dockerfile`, `devcontainer.json` и скрипты.
- Окружение включает JDK, Gradle и инструменты для разработки.
- Можно расширять Dockerfile для установки дополнительных средств.
Copy link
Collaborator

Choose a reason for hiding this comment

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

вот и впиши там в скобочках: дополнительных средств (например, <ссылка на yc cli>, <можно еще пример>)


### Python SDK (PR #590)
- В папке [`.devcontainer`](https://github.com/ydb-platform/ydb-python-sdk/pull/590/files) есть `Dockerfile`, `devcontainer.json`, `compose.yml` и скрипты для автоматической настройки окружения.
- Все зависимости, flake8, tox уже установлены.
Copy link
Collaborator

Choose a reason for hiding this comment

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

ссылки, что это flake8, tox

@ydbot
Copy link
Collaborator

ydbot commented Jun 27, 2025

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

Copy link

github-actions bot commented Jun 27, 2025

2025-06-27 17:28:19 UTC Pre-commit check linux-x86_64-relwithdebinfo for 015748c has started.
2025-06-27 17:28:30 UTC Artifacts will be uploaded here
2025-06-27 17:30:58 UTC ya make is running...
🟢 2025-06-27 17:31:03 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-27 17:31:13 UTC Build successful.

Copy link

github-actions bot commented Jun 27, 2025

2025-06-27 17:28:34 UTC Pre-commit check linux-x86_64-release-asan for 015748c has started.
2025-06-27 17:28:46 UTC Artifacts will be uploaded here
2025-06-27 17:31:20 UTC ya make is running...
🟢 2025-06-27 17:31:26 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-27 17:31:32 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (16)

⚠️ en/contributor/devcontainer/index.md: 24: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Java SDK"]

⚠️ en/contributor/devcontainer/index.md: 25: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 29: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Go SDK"]

⚠️ en/contributor/devcontainer/index.md: 30: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 35: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### JavaScript/TypeScript SDK"]

⚠️ en/contributor/devcontainer/index.md: 36: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 41: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Python SDK (PR #590)"]

⚠️ en/contributor/devcontainer/index.md: 42: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ ru/contributor/devcontainer/index.md: 24: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Java SDK"]

⚠️ ru/contributor/devcontainer/index.md: 25: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 29: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Go SDK"]

⚠️ ru/contributor/devcontainer/index.md: 30: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 35: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### JavaScript/TypeScript SDK"]

⚠️ ru/contributor/devcontainer/index.md: 36: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 41: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Python SDK (PR #590)"]

Log was truncated. (1 records)

@ydbot
Copy link
Collaborator

ydbot commented Jul 9, 2025

Heads-up: it's been 8 business-days since a reviewer comment. @polRk, any updates? @ElenaAfina, please check the status with the author.

@ydbot
Copy link
Collaborator

ydbot commented Jul 21, 2025

Heads-up: it's been 16 business-days since a reviewer comment. @polRk, any updates? @ElenaAfina, please check the status with the author.

polRk and others added 5 commits July 21, 2025 12:17
…nt SDKs

Signed-off-by: Vladislav Polyakov <polRk@ydb.tech>
Signed-off-by: Vladislav Polyakov <polRk@ydb.tech>
…older for SDK references

Signed-off-by: Vladislav Polyakov <polRk@ydb.tech>
Signed-off-by: Vladislav Polyakov <polRk@ydb.tech>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
@polRk polRk force-pushed the docs-devcontainer-for-contributors branch from f9cf50a to 07faa1e Compare July 21, 2025 09:17
@ydbot
Copy link
Collaborator

ydbot commented Jul 21, 2025

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

Copy link

github-actions bot commented Jul 21, 2025

2025-07-21 09:20:26 UTC Pre-commit check linux-x86_64-release-asan for 85aa110 has started.
2025-07-21 09:20:40 UTC Artifacts will be uploaded here
2025-07-21 09:21:25 UTC Check cancelled

…ndencies are pre-installed for each SDK

Signed-off-by: Vladislav Polyakov <polRk@ydb.tech>
@polRk polRk requested a review from ElenaAfina July 21, 2025 09:21
@ydbot
Copy link
Collaborator

ydbot commented Jul 21, 2025

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

Copy link

github-actions bot commented Jul 21, 2025

2025-07-21 09:23:26 UTC Pre-commit check linux-x86_64-release-asan for 8953122 has started.
2025-07-21 09:23:40 UTC Artifacts will be uploaded here
2025-07-21 09:26:02 UTC ya make is running...
🟢 2025-07-21 09:26:07 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-07-21 09:26:14 UTC Build successful.

Copy link

github-actions bot commented Jul 21, 2025

2025-07-21 09:25:18 UTC Pre-commit check linux-x86_64-relwithdebinfo for 8953122 has started.
2025-07-21 09:25:33 UTC Artifacts will be uploaded here
2025-07-21 09:28:04 UTC ya make is running...
🟢 2025-07-21 09:28:10 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-07-21 09:28:16 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (24)

⚠️ en/contributor/devcontainer/index.md: 24: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Java SDK"]

⚠️ en/contributor/devcontainer/index.md: 25: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 28: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Go SDK"]

⚠️ en/contributor/devcontainer/index.md: 29: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 33: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### JavaScript/TypeScript SDK"]

⚠️ en/contributor/devcontainer/index.md: 34: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ en/contributor/devcontainer/index.md: 38: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Python SDK (PR #590)"]

⚠️ en/contributor/devcontainer/index.md: 39: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- The [.devcontainer](https:..."]

⚠️ ru/concepts/vector_search.md: 57: MD030 / list-marker-space Spaces after list markers [Expected: 1; Actual: 2]

⚠️ ru/concepts/vector_search.md: 58: MD030 / list-marker-space Spaces after list markers [Expected: 1; Actual: 2]

⚠️ ru/contributor/devcontainer/index.md: 24: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Java SDK"]

⚠️ ru/contributor/devcontainer/index.md: 25: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 28: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Go SDK"]

⚠️ ru/contributor/devcontainer/index.md: 29: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "- В папке [.devcontainer](ht..."]

⚠️ ru/contributor/devcontainer/index.md: 33: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### JavaScript/TypeScript SDK"]

Log was truncated. (9 records)

@ydbot
Copy link
Collaborator

ydbot commented Jul 31, 2025

Heads-up: it's been 24 business-days since a reviewer comment. @polRk, any updates? @ElenaAfina, please check the status with the author.

@ydbot
Copy link
Collaborator

ydbot commented Aug 12, 2025

Heads-up: it's been 32 business-days since a reviewer comment. @polRk, any updates? @ElenaAfina, please check the status with the author.

@ydbot
Copy link
Collaborator

ydbot commented Aug 13, 2025

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

@ydbot
Copy link
Collaborator

ydbot commented Aug 14, 2025

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

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