diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d15e0353..41f3f7a0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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//` — 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. \ No newline at end of file diff --git a/README.md b/README.md index ad707b3b..efdeb328 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/_posts/2022-11-01-author-a-feature.md b/_posts/2022-11-01-author-a-feature.md index ab7a0139..8b72c1d3 100644 --- a/_posts/2022-11-01-author-a-feature.md +++ b/_posts/2022-11-01-author-a-feature.md @@ -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//` — **not** a path to an individual Feature (e.g., avoid `ghcr.io///`). 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).