-
Notifications
You must be signed in to change notification settings - Fork 741
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
polRk
wants to merge
6
commits into
main
Choose a base branch
from
docs-devcontainer-for-contributors
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+90
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2e1bae1
Add documentation on using Dev Container for contributors to YDB clie…
polRk 66a9911
Update navigation
polRk 1f82a43
Update Dev Container documentation to use {{ ydb-short-name }} placeh…
polRk eaecd0b
Fix typo in SDK section: change "Devcontainer" to "Dev Containers"
polRk 07faa1e
Update ydb/docs/ru/core/contributor/devcontainer/index.md
polRk f6bda6c
Update Dev Container documentation to clarify that all necessary depe…
polRk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Using Dev Container for Client {{ ydb-short-name }} SDK Contributors | ||
|
|
||
| - [Official Dev Containers Documentation](https://containers.dev/) | ||
| - [VS Code Dev Containers Extension Documentation](https://code.visualstudio.com/docs/devcontainers/containers) | ||
|
|
||
| Dev Container allows you to quickly set up a reproducible and isolated environment for developing and testing client {{ ydb-short-name }} SDKs. | ||
|
|
||
| ## Benefits of Dev Container | ||
|
|
||
| - No need for manual environment and dependency setup. | ||
| - The environment matches CI and other project contributors. | ||
| - You can run integration tests with a local {{ ydb-short-name }} database without extra preparation. | ||
| - All necessary tools for development and testing are pre-installed. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Install a container engine (e.g., [Docker](https://www.docker.com/) or [Podman](https://podman.io/)) and [Visual Studio Code](https://code.visualstudio.com/) with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). | ||
| 2. Clone the repository of the required [SDK](https://github.com/ydb-platform?q=sdk). | ||
| 3. If the repository contains a `.devcontainer` folder, open the project in VS Code and select **Reopen in Container**. | ||
| 4. After the environment starts, use standard commands to build, test, and run the code. | ||
|
|
||
| ## Implementation Details in {{ ydb-short-name }} SDKs | ||
|
|
||
| ### Java SDK | ||
| - The [`.devcontainer`](https://github.com/ydb-platform/ydb-java-sdk/tree/master/.devcontainer) contains a `Dockerfile`, `devcontainer.json`, and scripts for automatic environment setup. | ||
| - All necessary dependencies are pre-installed. | ||
|
|
||
| ### Go SDK | ||
| - The [`.devcontainer`](https://github.com/ydb-platform/ydb-go-sdk/tree/master/.devcontainer) contains a `Dockerfile`, `devcontainer.json`, `compose.yml`, and scripts for automatic environment setup. | ||
| - All necessary dependencies are pre-installed. | ||
| - When the environment starts, a local {{ ydb-short-name }} cluster is automatically started and access from the container is pre-configured. | ||
|
|
||
| ### JavaScript/TypeScript SDK | ||
| - The [`.devcontainer`](https://github.com/ydb-platform/ydb-js-sdk/tree/main/.devcontainer) contains a `Dockerfile`, `devcontainer.json`, `compose.yml`, and scripts for automatic environment setup. | ||
| - All necessary dependencies are pre-installed. | ||
| - When the environment starts, a local {{ ydb-short-name }} cluster is automatically started and access from the container is pre-configured. | ||
|
|
||
| ### Python SDK (PR #590) | ||
| - The [`.devcontainer`](https://github.com/ydb-platform/ydb-python-sdk/pull/590/files) contains a `Dockerfile`, `devcontainer.json`, `compose.yml`, and scripts for automatic environment setup. | ||
| - All necessary dependencies are pre-installed. | ||
| - When the environment starts, a local {{ ydb-short-name }} cluster is automatically started and access from the container is pre-configured. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Использование Dev Container для контрибьюторов клиентских SDK {{ ydb-short-name }} | ||
|
|
||
| - [Официальная документация Dev Containers](https://containers.dev/) | ||
| - [Документация расширения VS Code Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) | ||
|
|
||
| Dev Container позволяет быстро развернуть воспроизводимую и изолированную среду для разработки и тестирования клиентских {{ ydb-short-name }} SDK. | ||
|
|
||
| ## Преимущества Dev Container | ||
|
|
||
| - Не требуется ручная настройка окружения и зависимостей. | ||
| - Среда полностью совпадает с CI и другими участниками проекта. | ||
| - Можно запускать интеграционные тесты с локальной базой {{ ydb-short-name }} без дополнительной подготовки. | ||
| - Все необходимые инструменты для разработки и тестирования уже установлены. | ||
|
|
||
| ## Как начать работу | ||
|
|
||
| 1. Установите контейнерный движок (например, [Docker](https://www.docker.com/) или [Podman](https://podman.io/)) и [Visual Studio Code](https://code.visualstudio.com/) с расширением [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). | ||
| 2. Клонируйте репозиторий нужного [SDK](https://github.com/ydb-platform?q=sdk). | ||
| 3. Если в репозитории есть папка `.devcontainer`, откройте проект в VS Code и выберите команду **Reopen in Container**. | ||
| 4. После запуска среды используйте стандартные команды для сборки, тестирования и запуска кода. | ||
|
|
||
| ## Особенности реализации в {{ ydb-short-name }} SDK | ||
|
|
||
| ### Java SDK | ||
| - В папке [`.devcontainer`](https://github.com/ydb-platform/ydb-java-sdk/tree/master/.devcontainer) есть `Dockerfile`, `devcontainer.json` и скрипты для автоматической настройки окружения. | ||
| - Установлены все необходимые зависимости. | ||
|
|
||
| ### Go SDK | ||
| - В папке [`.devcontainer`](https://github.com/ydb-platform/ydb-go-sdk/tree/master/.devcontainer) есть `Dockerfile`, `devcontainer.json`, `compose.yml` и скрипты для автоматической настройки окружения. | ||
| - Установлены все необходимые зависимости. | ||
| - При запуске среды автоматически поднимается локальный кластер {{ ydb-short-name }}, к которому сразу настроен доступ из контейнера. | ||
|
|
||
| ### JavaScript/TypeScript SDK | ||
| - В папке [`.devcontainer`](https://github.com/ydb-platform/ydb-js-sdk/tree/main/.devcontainer) есть `Dockerfile`, `devcontainer.json`, `compose.yml` и скрипты для автоматической настройки окружения. | ||
| - Установлены все необходимые зависимости. | ||
| - При запуске среды автоматически поднимается локальный кластер {{ ydb-short-name }}, к которому сразу настроен доступ из контейнера. | ||
|
|
||
| ### Python SDK (PR #590) | ||
| - В папке [`.devcontainer`](https://github.com/ydb-platform/ydb-python-sdk/pull/590/files) есть `Dockerfile`, `devcontainer.json`, `compose.yml` и скрипты для автоматической настройки окружения. | ||
| - Установлены все необходимые зависимости. | ||
| - При запуске среды автоматически поднимается локальный кластер {{ ydb-short-name }}, к которому сразу настроен доступ из контейнера. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.