All-in-one doc template idea #16
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- This includes several sections usable for one or more document types: how-to, article, FAQ, and so forth. - A writer picks one of the templates and discards the rest of the markup. - The templates are displayed as code blocks by indenting 4 characters; this makes the markup visible on the rendered page. To use the template, the 4 characters must be removed. - All of this are just some ideas of how to create and maintain a single template. Signed-off by: Karsten Wade <kwade@redhat.com> <quaid@iquaid.org>
Closed
sesheta
added
the
size/L
margarethaley
requested changes
Jul 19, 2021
template-handbook-article.md
Outdated
| @@ -0,0 +1,147 @@ | |||
| <!-- Title, author, date block standard in all files --> | |||
| # Title (ex: How to Use `o1-clone` tool) | |||
There was a problem hiding this comment.
I would just suggest making "Use" lowercase instead, since we want the titles to be in sentence case. Other than that, I think it looks good!
There was a problem hiding this comment.
Also, maybe this document should go in the contributing folder?
Community Handbook
automation
moved this from Content in progress
to Review in progress
Jul 19, 2021
Signed-off by: Karsten Wade <kwade@redhat.com> <quaid@iquaid.org>
- This makes sense to have an easy directory with the files for contributing. - We'll have to link some/all of it into the Community Handbook, as well. Signed-off by: Karsten Wade <kwade@redhat.com> <quaid@iquaid.org>
margarethaley
approved these changes
Aug 6, 2021
Community Handbook
automation
moved this from Review in progress
to Approved, needs to be added to Table of Contents
Aug 6, 2021
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: margarethaley The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
sesheta
added
the
approved
Community Handbook
automation
moved this from Approved, needs to be added to Table of Contents
to Done
Aug 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off by: Karsten Wade kwade@redhat.com quaid@iquaid.org