Templates - Support for end-user documentation #12591
michaelbrewer
started this conversation in
RFCs
Replies: 1 comment 1 reply
-
The best way to probably do this is to make the README be the end user document, and add another markdown file like Honestly, we should probably do this for the example templates to set a good example. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
When creating a template there is a single readme, and is often geared towards to "template admin" user or the operator of the compute resources that a template needs.
I would like to propose that there be documentation geared toward the users who want to create a workspace.
These docs should be easy to find (currently the description field is too short and does not support hyper links or formatting), and should support markdown to allow template designers to include:
This will help developers know what this workspace can do for them, how to use it and how they could expand on the template.
Also there is going to be a large learning curve for how to migrate workloads off their local machines. And any guides to do so could be at the template level.
Beta Was this translation helpful? Give feedback.
All reactions