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

Devfile metadata: add a link to an external website #38

Closed
deboer-tim opened this issue Apr 15, 2020 · 6 comments · Fixed by #343
Closed

Devfile metadata: add a link to an external website #38

deboer-tim opened this issue Apr 15, 2020 · 6 comments · Fixed by #343
Assignees
Labels
area/api Enhancement or issue related to the api/devfile specification area/documentation Improvements or additions to documentation
Milestone

Comments

@deboer-tim
Copy link

When you use a devfile in an IDE, the IDE might want to be able to display a devfile-specific welcome page. Likewise, a command line tool might want to link to information on how to use the devfile. In both of these cases we want the devfile to provide the link and not pull other files into the user's project, which could be easily removed or annoying to clean up.

For cases like these it would be nice to have an optional doc url in the devfile metadata.

@deboer-tim deboer-tim added the area/api Enhancement or issue related to the api/devfile specification label Apr 15, 2020
@l0rd
Copy link
Contributor

l0rd commented Apr 28, 2020

We are going to add the website metadata at the top level of the devfile:

---
schemaVersion: 2.0.0
metadata:
  name: quarkus-stack
  description: ...
  website: https://quarkus.io

@l0rd
Copy link
Contributor

l0rd commented Apr 28, 2020

@deboer-tim if that's satisfies your need we are going to add that to the spec

@deboer-tim
Copy link
Author

+1. I don't love 'website', but I can't decide why or come up with a better option, so let's go with it. :)

@l0rd l0rd changed the title Documentation link Stack website metadata Apr 28, 2020
@l0rd l0rd changed the title Stack website metadata Stack metadata: add a link to an external website Apr 28, 2020
@l0rd l0rd changed the title Stack metadata: add a link to an external website Devfile metadata: add a link to an external website Apr 28, 2020
@l0rd
Copy link
Contributor

l0rd commented Apr 28, 2020

Yes we named it website because it includes but is broader then documentation.

@l0rd l0rd added this to the 2.0.0 milestone Jun 24, 2020
@l0rd l0rd mentioned this issue Jun 24, 2020
28 tasks
@kadel kadel removed this from the 2.0 milestone Jul 28, 2020
@GeekArthur GeekArthur self-assigned this Feb 11, 2021
@elsony elsony added this to the 2.1 milestone Feb 11, 2021
@elsony elsony added the area/documentation Improvements or additions to documentation label Feb 11, 2021
@elsony
Copy link
Contributor

elsony commented Feb 11, 2021

Stack author's guide needs to be updated to reflect that. We may want to consider to change https://docs.devfile.io/devfile/2.0.0/user-guide/adding-a-name-to-a-devfile.html to document metadata in general instead of just name so we can give examples to metadata in general including name, website, icons, etc.

This was referenced Feb 11, 2021
@GeekArthur
Copy link
Contributor

Stack author's guide needs to be updated to reflect that. We may want to consider to change https://docs.devfile.io/devfile/2.0.0/user-guide/adding-a-name-to-a-devfile.html to document metadata in general instead of just name so we can give examples to metadata in general including name, website, icons, etc.

Docs issue has been opened here: #345

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants