devcontainers/devcontainers.github.io

Web content for the development containers specification.

devcontainers.github.io's Issues

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

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)

Add Feature dependencies details to website

Add from devcontainers/spec#292

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

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. ❤️

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).

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.

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?

8

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!

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).

。。。

，，，，，，

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

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?

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

ω

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

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.

Update env docs

devcontainers/spec#233 (comment)

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

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

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 🤷‍♂️.

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.

Remove bugs and three parties

Don't allow anyone bugs

Repo

Why don't you want to stop

Add favicon

Likely use same dev container org logo.

"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?

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

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.

“BTC”通道公布及拉取

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

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

Friendychat

firebase/codelab-friendlychat-android@ddb5646

`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.