Skip to content

Commit

Permalink
Merge pull request #92 from DataRecce/doc/drc-653-in-recce-cloud-pr-p…
Browse files Browse the repository at this point in the history
…age-allow-to-create-codespace-by-recce

Update doc for default 'devcontainer.json' for recce cloud
  • Loading branch information
popcornylu authored Sep 18, 2024
2 parents aaf26b7 + 3d6adf4 commit 0513423
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions docs/docs/recce-cloud/setup-gh-codespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,16 @@ GitHub Codespaces is a development environment provided by GitHub that allows de
1. Prepare the two files in your repository
```
.devcontainer
├── Dockerfile
└── devcontainer.json
└── recce
├── Dockerfile
└── devcontainer.json
```
1. Configure the `.devcontainer/devcontainer.json`

!!! Tip

You can place the devcontainer configuration in [any valid location for Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#creating-a-custom-dev-container-configuration). However, Recce Cloud will prioritize using `.devcontainer/recce/devcontainer.json` if it is available.

1. Configure the `.devcontainer/recce/devcontainer.json`
```json
{
"name": "Recce CodeSpace",
Expand Down Expand Up @@ -83,9 +89,12 @@ For GitHub organization accounts, you can configure all Codespace charges to be
For more details on billing, please refer to the official [CodeSpace billing documentation](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces).



**Q: How to configure codespaces? What's the default dev container spec in Codespaces?**
**Q: How to configure codespaces?**

Codespace utilizes VSCode Dev Containers technology, which can be executed either locally (via Docker) or in the cloud (via GitHub Codespace). The configuration above provided are primarily recommendations for the recce cloud setup. For more advanced configuration options, you can refer to the [VSCode dev containers](https://code.visualstudio.com/docs/devcontainers/containers) or the [containers.dev](https://containers.dev/) documentation.

The default configuration for GitHub Codespace is explained in the [documentation](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). If you're looking to set up a development environment for dbt/Recce, you can also refer to the [Python project configuration documentation](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces).
The default configuration for GitHub Codespace is explained in the [documentation](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). If you're looking to set up a development environment for dbt/Recce, you can also refer to the [Python project configuration documentation](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces).

**Q: Can I have multiple devcontainer configurations? Which one is selected by default?**

Yes, you can. Please refer to the [Codespaces documentation](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#creating-a-custom-dev-container-configuration) for more details. Recce Cloud will prioritize `.devcontainer/recce/devcontainer.json` if it is available. If not, it will default to `.devcontainer/devcontainer.json`, and then any other available configurations.

0 comments on commit 0513423

Please sign in to comment.