Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown file of supported tags #1327

Open
mthalman opened this issue Jan 16, 2025 · 3 comments
Open

Markdown file of supported tags #1327

mthalman opened this issue Jan 16, 2025 · 3 comments

Comments

@mthalman
Copy link
Member

The current method for determining the available tags in this repo isn't great. There are only two sources of information:

  • image info - This is a JSON file that includes a lot of metadata and isn't the easiest to visually parse
  • all tags - This provides a view of every single tag, including those that are not supported

We should consider providing a markdown file that lists the supported tags in table format, in the same way that is done with the official container images. This would allow consumers of the images to more easily locate the available tags and select the one they need.

@richlander
Copy link
Member

I'm in favor of status-quo. While everything about this repo is public, we're not trying to encourage the use of these images. It's OK if others use them, but there is no SLA/support for them. The lack of documentation on the images is a tacit statement about the SLA.

I see no reason to improve the experience for our own team. The JSON file seems sufficient to me. I've never had trouble using it.

@akoeplinger
Copy link
Member

The JSON file doesn't tell you that e.g. the azurelinux images are preferred over the old cbl-mariner ones.
If we're concerned about SLA/support then we can just say so in the readme.

@mthalman
Copy link
Member Author

Chatted with @richlander offline. We agreed it will be acceptable to have a tags table represented. The support concerns have been addressed by #1347.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants