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

Add more information about devfile samples in devfile.io #1691

Open
1 task
thepetk opened this issue Feb 17, 2025 · 0 comments
Open
1 task

Add more information about devfile samples in devfile.io #1691

thepetk opened this issue Feb 17, 2025 · 0 comments
Labels
area/documentation Improvements or additions to documentation area/registry Devfile registry for stacks and infrastructure

Comments

@thepetk
Copy link
Contributor

thepetk commented Feb 17, 2025

/area documentation

Which area is this documentation change related to?

/area registry

Issue details

The current documentation doesn't explain in depth the usage & purpose of devfile samples in the devfile registry.

We could create a new page that covers:

  • What is a devfile sample?
  • What is the difference of devfile samples and registry stacks?
  • When devfile samples are used?
  • Where the devfile samples are used?

This could help users that want to distinguish the two different concepts: stacks & samples

Acceptance Criteria

  • The documentation now includes a new page that now covers the above topics
@openshift-ci openshift-ci bot added area/documentation Improvements or additions to documentation area/registry Devfile registry for stacks and infrastructure labels Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/registry Devfile registry for stacks and infrastructure
Projects
Status: No status
Development

No branches or pull requests

1 participant