Skip to content

Commit ac8d151

Browse files
avillelachalin
andauthored
Add devcontainer.json for local development using devcontainers (#6738)
Co-authored-by: Patrice Chalin <[email protected]>
1 parent 104141a commit ac8d151

File tree

4 files changed

+66
-0
lines changed

4 files changed

+66
-0
lines changed

.devcontainer/devcontainer.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"name": "default",
3+
"image": "mcr.microsoft.com/devcontainers/base:dev-bullseye",
4+
"features": {
5+
"ghcr.io/devcontainers/features/node:1": {}
6+
},
7+
"overrideFeatureInstallOrder": [],
8+
"hostRequirements": {
9+
"cpus": 4,
10+
"memory": "16gb",
11+
"storage": "16gb"
12+
},
13+
"remoteEnv": {
14+
"PODMAN_USERNS": "keep-id"
15+
},
16+
"containerUser": "vscode",
17+
"postStartCommand": ".devcontainer/post-start.sh"
18+
}

.devcontainer/post-start.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/bash
2+
3+
nvm install
4+
npm install

content/en/docs/contributing/development.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,30 @@ Gitpod automatically installs the repo-specific packages for you.
2828
You're now ready to [build](#build), [serve](#serve) or make updates to the
2929
website files.
3030

31+
## Development container setup
32+
33+
{{% alert title="Note" %}}
34+
35+
[Development (dev) containers](https://containers.dev/) are a standard. You can
36+
therefore you run the dev container for this repository using any tool
37+
supporting this standard, such as:
38+
39+
- [GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#about-dev-containers)
40+
- [DevPod](https://devpod.sh/docs/developing-in-workspaces/devcontainer-json)
41+
- [VSCode](https://code.visualstudio.com/docs/devcontainers/containers#_installation)
42+
43+
{{% /alert %}}
44+
45+
1. [Fork][] and then [clone][] the website repository at
46+
<{{% param github_repo %}}>.
47+
48+
2. Go to the repository directory.
49+
50+
3. Open up the project in your favorite Dev Container tool.
51+
52+
You're now ready to [build](#build), [serve](#serve) or make updates to the
53+
website files.
54+
3155
## Local setup
3256

3357
1. [Fork][] and then [clone][] the website repository at

static/refcache.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -539,10 +539,18 @@
539539
"StatusCode": 206,
540540
"LastSeen": "2025-02-01T06:58:05.02751-05:00"
541541
},
542+
"https://code.visualstudio.com": {
543+
"StatusCode": 206,
544+
"LastSeen": "2025-04-22T19:19:29.392140654Z"
545+
},
542546
"https://code.visualstudio.com/": {
543547
"StatusCode": 206,
544548
"LastSeen": "2025-01-30T16:59:55.593014-05:00"
545549
},
550+
"https://code.visualstudio.com/docs/devcontainers/containers#_installation": {
551+
"StatusCode": 206,
552+
"LastSeen": "2025-04-22T19:19:32.045577138Z"
553+
},
546554
"https://collectd.org/wiki/index.php/Binary_protocol": {
547555
"StatusCode": 206,
548556
"LastSeen": "2025-01-13T11:43:49.558162-05:00"
@@ -583,6 +591,10 @@
583591
"StatusCode": 206,
584592
"LastSeen": "2025-01-15T13:17:28.36005-05:00"
585593
},
594+
"https://containers.dev/": {
595+
"StatusCode": 206,
596+
"LastSeen": "2025-04-22T19:19:25.586763282Z"
597+
},
586598
"https://contribute.cncf.io/resources/project-services/audits/": {
587599
"StatusCode": 206,
588600
"LastSeen": "2025-01-04T17:06:30.360149-05:00"
@@ -927,6 +939,10 @@
927939
"StatusCode": 200,
928940
"LastSeen": "2025-01-30T16:59:50.483226-05:00"
929941
},
942+
"https://devpod.sh/docs/developing-in-workspaces/devcontainer-json": {
943+
"StatusCode": 206,
944+
"LastSeen": "2025-04-30T15:20:21.96523571Z"
945+
},
930946
"https://devstats.cncf.io/": {
931947
"StatusCode": 206,
932948
"LastSeen": "2025-01-06T11:33:39.730093-05:00"
@@ -1239,6 +1255,10 @@
12391255
"StatusCode": 206,
12401256
"LastSeen": "2025-02-01T07:20:41.337867-05:00"
12411257
},
1258+
"https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#about-dev-containers": {
1259+
"StatusCode": 206,
1260+
"LastSeen": "2025-04-30T15:20:20.247498933Z"
1261+
},
12421262
"https://docs.github.com/en/get-started/learning-about-github/github-glossary#pull-request": {
12431263
"StatusCode": 200,
12441264
"LastSeen": "2025-02-06T02:05:12.345Z"

0 commit comments

Comments
 (0)