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

Fix schema documentation link in README #1688

Open
clayrosenthal opened this issue Feb 5, 2025 · 2 comments · May be fixed by #1689
Open

Fix schema documentation link in README #1688

clayrosenthal opened this issue Feb 5, 2025 · 2 comments · May be fixed by #1689
Labels
area/api Enhancement or issue related to the api/devfile specification area/documentation Improvements or additions to documentation area/landing-page Issues with the Landing Page

Comments

@clayrosenthal
Copy link

/area documentation

Which area is this documentation change related to?

/area api
/area landing-page

Issue details

The link in the to the generated schema in the README.md points to an old link, devfile.github.io, it seems the new docs are at https://devfile.io/docs/2.3.0

What mistake did you find / what is missing in the documentation?

The link to the docs is missing.

@openshift-ci openshift-ci bot added area/documentation Improvements or additions to documentation area/api Enhancement or issue related to the api/devfile specification area/landing-page Issues with the Landing Page labels Feb 5, 2025
@michael-valdron
Copy link
Member

michael-valdron commented Feb 6, 2025

Hi @clayrosenthal,

Thank you for your contribution! 😄

If you would like to add this change, would you kindly re-open clayrosenthal#1 under the source repository devfile/api.

We would gladly take a look at what you have revised in our README.

@clayrosenthal clayrosenthal linked a pull request Feb 6, 2025 that will close this issue
4 tasks
@clayrosenthal
Copy link
Author

Whoops, misread the repo on the PR. Opened on the correct repo now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Enhancement or issue related to the api/devfile specification area/documentation Improvements or additions to documentation area/landing-page Issues with the Landing Page
Projects
Status: No status
2 participants