Add "Supported Distros" column to Features table (and consider adding to spec)

オープン
#654 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
html, json
領域
documentation

調査の方向性

https://containers.dev/features の Features テーブルと、https://containers.dev/implementors/features/ の Features 実装ノートから始めます。次に devcontainer-feature.json の仕様を見つけ、サポート対象の distro 情報をどのように表現し、テーブルに表示すべきかを確認します。要求された互換性情報が一貫して文書化され、受け入れられた場合は仕様変更も含まれていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

I've encountered situations where I want to add a Feature to a devcontainer configuration, only to discover later that it supports only certain distros or package managers. This typically becomes apparent only at build time, leading to wasted effort.

To improve the experience, I'd like to suggest adding a "Supported Distros" column to the Features table at https://containers.dev/features. Displaying this information up front (rather than having it buried in project READMEs) would make it easier to determine whether a Feature can be used with a specific base image or distro, saving time and reducing confusion.

Since the spec already acknowledges this limitation in the docs:

Note: While Features may be installed on top of any base image, the implementation of a Feature might restrict it to a subset of possible base images. For example, some Features may be authored to work with a certain Linux distro (e.g. debian-based images that use the apt package manager).

It might be worth adding a supportedDistros property to the devcontainer-feature.json spec itself. This would improve discoverability, allow the documentation to be auto-generated and ensure distro compatibility is consistently documented across all Features.

Thanks for considering this enhancement!

主要言語
HTML
スター
207
フォーク
435
平均マージ
2日 7時間
マージ済み PR(30日)
2

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

devcontainers/devcontainers.github.io のほかの issue

devcontainers/devcontainers.github.io の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。