Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ _If your PR contributes a new collection, please utilize this checklist:_
- [ ] Maintainer name
- [ ] Maintainer contact link (i.e. link to a GitHub repo, email)
- [ ] Repository URL
- [ ] OCI Reference
- [ ] OCI Reference (must be the collection root, e.g. `ghcr.io/<owner>/<repo>` — one entry per repository, not one per Feature; do not include `http://` or `https://`)
- [ ] I acknowledge that this collection provides new functionality, distinct from the existing collections part of this index.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ It is from this [Jekyll Dev Container Template](https://github.com/devcontainers

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.

If you'd like to add your own Features or Templates collection to the [community index](https://containers.dev/collections), please read the [Authoring a Dev Container Feature](https://containers.dev/guide/author-a-feature) guide first — in particular the [Adding Features to the Index](https://containers.dev/guide/author-a-feature#add-to-index) section, which explains how to correctly format your `collection-index.yml` entry.

For issues on and contributions to the dev container specification itself, please visit the [Dev Containers Spec repo](https://github.com/devcontainers/spec).

## License
Expand Down
2 changes: 2 additions & 0 deletions _posts/2022-11-01-author-a-feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,6 @@ If you'd like your Features to appear in our [public index](/features) so that o
* Open a PR to modify the [collection-index.yml](https://github.com/devcontainers/devcontainers.github.io/blob/gh-pages/_data/collection-index.yml) file
* Features housed in other OCI Artifact container registries can be included as long as they can be downloaded without a login.

> **Note:** Add a **single entry per repository**, regardless of how many Features it contains. The `ociReference` should be the collection namespace root — e.g., `ghcr.io/<owner>/<repo>`**not** a path to an individual Feature (e.g., avoid `ghcr.io/<owner>/<repo>/<featureName>`). The site will automatically discover all Features in the collection from that one entry. The `ociReference` value must not include a URL scheme such as `http://` or `https://`.
Feature collections are scanned to populate a Feature index on the [containers.dev site](/features) and allow them to appear in Dev Container creation UX in [supporting tools](https://containers.dev/supporting) like [VS Code Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and [GitHub Codespaces](https://github.com/features/codespaces).