Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Templates - Support for end-user documentation#12591

michaelbrewer started this conversation inRFCs
Discussion options

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:

  • capabilities of the workspace
  • usage docs
  • feedback links
  • support links
  • contribution guides
  • etc.

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.

You must be logged in to vote

Replies: 1 comment 1 reply

Comment options

The best way to probably do this is to make the README be the end user document, and add another markdown file liketemplate.md in the template directory. People who are working on the template can refer to that document in their IDE when necessary, and you can mention it in the README for discoverability (although linking to it won't work as far as I'm aware).

Honestly, we should probably do this for the example templates to set a good example.

You must be logged in to vote
1 reply
@michaelbrewer
Comment options

Makes sense. Good examples would help people copy and change :)

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Category
RFCs
Labels
None yet
2 participants
@michaelbrewer@deansheather

[8]ページ先頭

©2009-2025 Movatter.jp