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

Update 2.2.0 Author’s guide to include new feature introduced #809

Closed
yangcao77 opened this issue Mar 30, 2022 · 0 comments · Fixed by devfile/docs#150
Closed

Update 2.2.0 Author’s guide to include new feature introduced #809

yangcao77 opened this issue Mar 30, 2022 · 0 comments · Fixed by devfile/docs#150
Assignees
Labels
area/api Enhancement or issue related to the api/devfile specification area/documentation Improvements or additions to documentation

Comments

@yangcao77
Copy link
Contributor

yangcao77 commented Mar 30, 2022

/area documentation

Which area this documentation change is related to?

/area api

Issue details

What mistake did you find / what is missing in the documentation?
Update 2.2.0 Author’s guide to include new feature introduced

changes I noticed need to be made:

  1. main menu is missing "adding event bindings". https://devfile.io/docs/devfile/2.2.0/user-guide/authoring-devfiles/
  2. all 2.2.0 doc need to update example devfile to use schemaVersion 2.2.0. (currently it's still 2.1.0)
  3. command section missing apply command section,
  4. missing deploy command group( https://devfile.io/docs/devfile/2.2.0/user-guide/adding-a-command-group-to-a-devfile/)
  5. image component section is missing
  6. Kubernetest component need to be updated with explanation on deployByDefault (default it's not deployed during startup, need to created & run deploy command)
  7. container component missing example of having volume reference (? or should it be under volume component section?)
  8. parent reference missing version property (recently added to support multi-version registry)
@openshift-ci openshift-ci bot added area/documentation Improvements or additions to documentation area/api Enhancement or issue related to the api/devfile specification labels Mar 30, 2022
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.

2 participants