devcontainers / devcontainers.github.io

Web content for the development containers specification.

Development Containers Website

This repo holds the website for the Development Containers Specification.

You may view the site at containers.dev.

Building

If you'd like to build and preview the site yourself, we make it as smooth as possible through a dev container in this repo!

Dev container

You may build GitHub Pages sites with Jekyll, which is a Ruby gem. You could manually install these tools on your machine, or you can easily get started with the setup you already need through a dev container!

You may review this repo's dev container in the .devcontainer folder.

It is from this Jekyll Dev Container Template.

Steps to build and run

• Clone or open this repo in the dev container-supporting editor of your choosing.
  • You may review supporting tools and services here.
• Reopen this repo in the dev container, so that the container builds and you may develop inside it using the included tools.
• Once the dev container finishes building, execute the following command in your dev container to start the site: bundle exec jekyll serve
• Check out the site! http://localhost:4000/containers.dev/

Feedback and contributing

If you'd like to provide feedback on or contribute to the dev containers website, please feel free to open an issue or PR in this repo.

For issues on and contributions to the dev container specification itself, please visit the Dev Containers Spec repo.

License

License for this repository: https://github.com/devcontainers/containers.dev/blob/gh-pages/LICENSE.

devcontainers.github.io's Issues

Update action link in prebuild guide

From https://github.com/devcontainers/devcontainers.github.io/pull/277/files#r1313616515:

The link here to the GitHub Action does not work. Maybe it is not published in the Marketplace?

Add Feature dependencies details to website

Add from devcontainers/spec#292

Add instructions to update collection-index.yml to CONTRIBUTING.md

Right now the only place with instructions on what to add to the collections-index.yml file and how to do it are at https://containers.dev/collections. I think that there should be a similar blurb added to the CONTRIBUTING.md file for this repository.

Sidenote: it currently seems like the contributing guide for this repo focuses very heavily on the specification itself, and not the docs website that makes up the bulk of this repo.

https://github.com/devcontainers/devcontainers.github.io/blob/4b6f855e772e8e6cfa4fc5fc38460e01fb01443a/contributing.md

RSS feed doesn't work

Found while opening #241 🤣

https://containers.dev/guides

There doesn't appear to be a feed.xml in the github source. I don't think feed.xml exists at all? https://github.com/search?q=repo%3Adevcontainers%2Fdevcontainers.github.io%20feed.xml&type=code

Anchor on a specific attribute

Feature request originally from @joshspicer

eg: send https://containers.dev/implementors/json_reference/#remoteEnv , which anchors the screen on the remoteEnv attribute

I manually added links to make each header clickable (i.e. https://containers.dev/implementors/json_reference/#image-specific) - it seems making these individual attributes into links is possible but would be quite time-consuming (there are many attributes, need to make each one into a unique link).

[README.md](https://github.com/devcontainers/images/files/15172554/README.md)

          [README.md](https://github.com/devcontainers/images/files/15172554/README.md)

Originally posted by @MrNice78 in devcontainers/images#1026 (comment)

pull request

Update containers.dev with the latest version of the spec

I accidentally discovered build.options is a new field in devcontainer.json, but it's not listed as a field on containers.dev. It'd be great if the public site were updated with the latest version of the spec.

#399

          #399

Originally posted by @JustDontsnitchonme in #402 (comment)

How to develop totally in a remote host's devcontainer?

hi, folks,
From the develp-remote-host, the steps as below:

1. Follow the [installation](https://code.visualstudio.com/docs/remote/ssh#_installation) and SSH [host setup](https://code.visualstudio.com/docs/remote/ssh#_ssh-host-setup) steps for the Remote - SSH extension.
2. Optional: Set up SSH [key based authentication](https://code.visualstudio.com/docs/remote/troubleshooting#_configuring-key-based-authentication) to the server so you do not need to enter your password multiple times.
3. [Install Docker](https://code.visualstudio.com/docs/devcontainers/containers#installation) on your SSH host. You do not need to install Docker locally.
4.Follow the [quick start](https://code.visualstudio.com/docs/remote/ssh#_connect-to-a-remote-host) for the Remote - SSH extension to connect to a host and open a folder there.
5. Use the Dev Containers: Reopen in Container command from the Command Palette (F1, Ctrl+Shift+P).

It seems there must be a folder in the remote host and then to open it in the devcontainer. Is it possbile to clone a repo directly in the container on the remote host ? I tried but falied started on this way.

。。。

，，，，，，

Updates to /features and /collections pages

Necessary changes:

• Link to these pages from the root

Other UX changes to consider:

• Add "Features" to header, would link to https://containers.dev/features
• Break them into categories to avoid very lengthy tables
• Consider adding icons and making them "cards": https://www.gatsbyjs.com/plugins/

cc @joshspicer

Create a repo dedicated to prebuilds and add it to the prebuild guide

From #277 (review):

Maybe a separate sample repo just showing off prebuilds would makes it easier for users to get an overview of what is needed. Not a requirement though.

If anyone from the community happens to have one they'd like to contribute to this guide as an example, we'd definitely welcome it!

Repo

Why don't you want to stop

Website documentation needs search functionality

Currently as of 07-26-2023, there is no ability to search the Containers.dev website for specific reference information.

This would be a well used feature that would help better adoption of the devcontainer spec.

Seems like this is possible via Algolia.

https://dev.to/adrienjoly/make-your-static-site-searchable-with-jekyll-algolia-edh

"Reference Implementation Features" removed from devcontainer-index.json

I'm not entirely clear if:

• this is an issue
• this issue pertains to this repository
• where devcontainer-index.json is published from, but I'm thinking it must be sourced from _data/collection-index.yml

An issue was recently reported with the vscode devcontainers extension. microsoft/vscode-remote-release#9538

I did a little troubleshooting and saw that it was failing due to a change in devcontainer-index.json.
I compared the current and previous versions of this file to get a clue as to what changed.
current:
oras pull ghcr.io/devcontainers/index:latest
previous:
oras pull ghcr.io/devcontainers/index@sha256:939b11cdd0462c617735721c53b082e1953189cfb6c698f5dd08660db4c6afe9

I'm seeing that "Reference Implementation Features" was removed... The vscode extension must depend on this though I'm unclear where the code now lives for the vscode extension.

Was this change to devcontainer-index.json intentional?

8

`customization`?

Seeking clarification on docs regarding customizations...

A customizations property exists in both devcontainers and features. But have pretty different descriptions. Is this the same customizations? The devcontainer version has a link that illustrates and gives vscode examples for extensions array and settings object. btw, will these VS Code customizations be added to features?

Devcontainers - json_reference.md

customizations 🏷️	object	Product specific properties, defined in supporting tools

Features - features.md

customizations	object	Product specific properties, each namespace under customizations is treated as a separate set of properties. For each of this sets the object is parsed, values are replaced while arrays are set as a union.

Handle unmaintained dev containers

Maintainers of dev container features may discontinue the support of their container. This should be detected and resolved automatically.

Close #563

Close #563

I added --cache-to option to devcontainer build command.

If buildx is used for building image, we can pass --cache-to option in order to export and reuse buildx cache.

Checks

• Create docker-container driver builx builder
  • docker buildx create --driver=docker-container --use
• Build with --cache-to option
  • node devcontainer.js build --workspace-folder . --cache-to=type=local,dest=/tmp/build-cache
• Confirm cache directory exists
  • ls /tmp/build-cache

❯ ls /tmp/build-cache
blobs  index.json  ingest  oci-layout

Originally posted by @yokonao in devcontainers/cli#570

Hi 👋

          Hi 👋 

This is insufficient since it does not say anything about the working directory when the command is run.

The document does mention "⚠️ The command is run wherever the source code is located on the host. For cloud services, this is in the cloud." which already answers your question about the working directory.

Let us know which bit of information is confusing to you, happy to enhance the docs. Thanks!

Originally posted by @samruddhikhandale in devcontainers/spec#436 (comment)

Consider using a blog platform for posts?

Hello! 👋

This is a suggestion. Feel free to "transfer to Discussion" or whatever if this isn't right for an issue. 😊

I think that it might be worth consider either a) cross-posting the blog-like posts from https://containers.dev/guides to https://dev.to/ or another blog platform OR b) using dev.to or another blog-like platform as your CMS for posts.

My pro/con thoughts (my opinions)

Using something like dev.to would have the following advantages:

• Users can't open PRs for old posts. They stay frozen in time as you the author wrote them.
• Authorship is much more "traditional" and less "code-y". You have a few names and links at the top instead of commit history.
• Less friction to create new posts. You just click "+" in your dev.to or other platform and boom new post!
• More friendly for non-GitHub users (BitBucket, GitLab, etc) since it's a separate platform?
• Content is more "distant" from the implementation details and specification; it's a blog not a specification changelog chronicle!
• Designed for blog posting.
• Better Google SEO. dev.to posts seem (from my experience) to be much more Google-able. Even having just an RSS-feed mirror might aid SEO? Since one of the posts is titled "best practices", this would seem to be a worthwhile goal 😉
• Better subscription notifications. You don't need to re-implement an email listing workflow, just use dev.to or Medium's subscription/follow mechanism.
• Analytics. You actually get some kind of feedback system since dev.to (or Medium or whatever) was designed for blogging 😁
• Builtin RSS feed! The current RSS feed doesn't work. https://containers.dev/feed.xml Using a built-for-blogging system would hopefully solve this.

Using something like dev.to would have the following disadvantages:

• Other contributors would not be able to open PRs for old posts. They would become outdated over time.
• No commit-like history of contributor's contributions (if anyone else collaborated to make a post)
• Lose the extremely tight GitHub integration. Content is a bit more "distant" from the specification and implementation details.

As you may have guessed, I like the idea of having blog content separate from the "code content" (or similar code-y content) to use the right tool for the job. However, other users have used GitHub as the CMS and then mirrored to dev.to or other platforms with great success!
https://dev.to/aralroca/say-goodbye-to-spread-operator-use-default-composer-3c2j
https://dev.to/perssondennis/if-we-only-had-five-vs-code-extensions-4ge4
https://dev.to/srebalaji/branch-based-vs-trunk-based-development-557a
https://dev.to/emma/using-the-dev-api-to-add-dev-to-comment-counts-to-my-blog-3cd
https://dev.to/shaunchurch/optimistic-user-interfaces-a-good-kind-of-lie-1fek

I think the best reason to consider syndicating content elsewhere (the https://indieweb.org/POSSE philosophy) is better SEO for google-ability. If I search for "devcontainer guide", I get a dev.to article, not the official blog! 🤣

I think that creating such an https://dev.to/devcontainers organization and mirroring the RSS feed there is good idea.

You can create an organization and import an RSS feed! It's that simple!
https://dev.to/organization-info
https://dev.to/settings/organization

Remove or alert about devcontainers-contrib project

Currently there's a large number of features that are listed on https://containers.dev/features from the devcontainers-contrib/features repository. Due to the large number of features and the name of the project it misleads people to believe that it is a project officially associated with the devcontainers project, I know I have myself.

However as shown in #168, it is actually a personal project maintained by one person @danielbraun89 who, in a deleted issue, has refused to add any other maintainers. That person has now stopped maintaining the project as described in devcontainers-contrib/features#628 and various features are beginning to break, such as devcontainers-contrib/features#625 or devcontainers-contrib/features#631. The maintainer is not updating them and is not merging PRs.

This shouldn't be something that is up to the devcontainers project to manage but in absence of the maintainer providing any information about it being a single user project and the apparent abandonment, it should be removed from the list of features on the containers.dev site and perhaps some warning should be provided on the site.

page width?

It seems that page width is not enough for the table.

https://containers.dev/implementors/spec/#merge-logic

Friendychat

firebase/codelab-friendlychat-android@ddb5646

ω

ω？🌞1️⃣2☎️煩躁😫@

Update env docs

devcontainers/spec#233 (comment)

Add favicon

Likely use same dev container org logo.

Contrast issue on Microsoft logo

The Microsoft logo on the https://containers.dev/ homepage is currently very white... on a white background.

I don't think this was intentional. It's a minor nitpick, I know. Is there a procedure to go about contributing? The contributing.md seems geared towards the spec repo, so I don't really know if you even want contributions from outsiders for this website repo 🤷‍♂️.

Website documentation needs search functionality

Currently as of 07-27-2023, there is no ability to search the Containers.dev website for specific reference information.

This would be a well used feature that would help better adoption of the devcontainer spec.

Seems like this is possible via Algolia.

https://dev.to/adrienjoly/make-your-static-site-searchable-with-jekyll-algolia-edh

Docs / Github Watch Link in footer on https://containers.dev is broken

On all pages of https://containers.dev in the footer next to Github Star the Github Watch link https://github.com/Microsoft/dev-container-spec/subscription is broken.

Decommision devcontainers.org in favor of containers.dev

As a user it is really confusing to find two different websites for the devcontainers specification.

The only relevant document in https://devcontainers.org that is not avaiable in https://containers.dev is the living spec. We should probably move that one and fix #25 (as a side effect).

Finally there are many broken links on devcontainers.org and it is clearly unmaintained :

404 Not Found | https://containers.dev/spec/ | the various devcontainer.json options
404 Not Found | https://dev.to/devcontainers | our @devcontainers dev.to page
404 Not Found | https://devcontainers.org/markdown-examples.html | Examples
404 Not Found | https://devcontainers.org/supporting-tools | Supporting tools
404 Not Found | https://devcontainers.org/assets/example-devcontainerjson.616e7f2e.png | img/src
404 Not Found | https://devcontainers.org/api-examples.html | Runtime API Examples
404 Not Found | https://devcontainers.org/assets/inter-roman-cyrillic.5f2c6c8c.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-roman-cyrillic-ext.e75737ce.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-roman-greek.d5a6d92a.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-roman-greek-ext.ab0619bc.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-roman-latin.2ed14f66.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-roman-latin-ext.0030eebd.woff2 | style: @font-face
404 Not Found | https://oras.land/implementors/ | found here
404 Not Found | https://devcontainers.org/assets/inter-roman-vietnamese.14ce25a6.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-italic-cyrillic.ea42a392.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-italic-cyrillic-ext.33bd5a8e.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-italic-greek.8f4463c4.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-italic-greek-ext.4fbe9427.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-italic-latin.bd3b6f56.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-italic-latin-ext.bd8920cc.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/inter-italic-vietnamese.6ce511fb.woff2 | style: @font-face
404 Not Found | https://devcontainers.org/assets/dev-container-stages.91fa2288.png | img/src
404 Not Found | https://devcontainers.org/features | Dev Container Feature
404 Not Found | https://devcontainers.org/spec/supporting-tools.md | supporting tools section
404 Not Found | https://devcontainers.org/spec/devcontainer-features-distribution.md | devcontainer-features-distribution.md
404 Not Found | https://devcontainers.org/spec/devcontainer-features.md | Dev Container Features
404 Not Found | https://devcontainers.org/docs/specs/supporting-tools.md | supporting tools

Search doesn't work on Templates

#325 added search functionality across the Features, Templates, and Collections pages. The search works well on Features and Collections but doesn't seem to work for me on Templates.

@samruddhikhandale do you see the same behavior? And do you have any recommendations for how to test this locally (as mentioned in #325, I can test Collections pretty easily since they load when I build and run the site locally, but Features and Templates don't populate locally for me when testing).

Remove bugs and three parties

Don't allow anyone bugs

Auto deploy changes from `devcontainers/spec` to containers.dev

It would be great to automate the deployment of spec changes. Right now we do a 1:1 copy with minor formatting tweaks - so it shouldn't be too hard.

Improve documentation on devcontainer templates

While documentation for devcontainers and devcontainer features is well written, documentation for templates is bad, it covers well only template building, but not using, for example:

• how to use existing templates in projects? (working samples of code, what is on the site or in devcontainers templates --help tells me nothing
• is it possible for one project to use multiple templates?

Update

          @JoftheV please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Originally posted by @microsoft-github-policy-service[bot] in devcontainers/features#1063 (comment)

Remove template entries from the list of available dev container features

The current dev container features list contains entries from the example template.

Consider using Issue Forms for collections-index.yml?

Hello! 👋

This is an idea. If this is out-of-scope or something that seems too costly to maintain, that's OK.

https://github.com/stefanbuck/ristorante
https://github.com/stefanbuck/awesome-browser-extensions-for-github
☝ basically that.

https://stefanbuck.com/blog/codeless-contributions-with-github-issue-forms

Why this would be a cool idea:

• Reduce the need to make tiny manual comments that could be done via a GitHub Action and a regex #159 #226
• Make adding a new collection more user-friendly (new issue instead of fork+PR)

I am willing to contribute code to do this. ❤️

“BTC”通道公布及拉取

BTC相關資料拉取使用通報，本人宣布使用者已經得到相關部門法律文件批准，保証一切真實情況本人實名登記來 感謝聯邦政府支持和基金會的協助 最後還是自我介紹一下Ac中文（陳x鈔）來自中國大陸公民權利。

• btc相關資料需要提交的謝謝提醒一下。第一次接觸有點蒙圈