odo icon indicating copy to clipboard operation
odo copied to clipboard

More Devfile documentation on website

Open cdrage opened this issue 4 years ago • 0 comments

/kind documentation

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

In general.. where is all the Devfile documentation? How do I go from that user that's learned odo in 30 minutes, to an advanced user that can add customer k8s resources, edit my Devfile and push to my enterprise cluster?

There are some missing Devfile documentation on the odo.dev site that I feel should be there:

  • [ ] No references to Devfile on https://odo.dev/docs/getting-started/features Devfile is definitely a feature of odo
  • [ ] Broken link to Devfile on https://odo.dev/docs/getting-started/basics (see bottom of the page, where it says: "See Devfile"
  • [ ] There is a command reference page for odo, but no links on the site that points to Devfile, at all really.. I couldn't find one link (within 5 minutes) that details the Devfile documentation.
  • [ ] This tutorial references Devfile.. but does not point the user to where the documentation should be / continue the tutorial: https://odo.dev/docs/tutorials/deploying-a-devfile-using-odo-on-IBM-Z-and-Power
  • [ ] Same for here.. This tutorial also references Devfile but no other resource links: https://odo.dev/docs/tutorials/using-devfile-odo.dev.push.path-attribute
  • [ ] More links to Devfile github page / website / etc.

Changes that I believe should be implemented:

  • [x] Devfile's own section "Devfile Reference" similar to "Command Reference" that is already there. This makes sense logically as the further you go down the list, the more advance it becomes.. First you go through: Getting Started Using odo then Command Reference then Devfile Reference and lastly are the advanced tutorials.
  • [x] Devfile Reference section should have an "intro" section as well as pages for advanced features / implementations / etc.

What is the relevance of it?

More documentation for new users

cdrage avatar Jan 11 '22 17:01 cdrage