-
Notifications
You must be signed in to change notification settings - Fork 170
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From a US dialect edit this is definitely approved.
There are some wider questions about title casing that may need to be started up as a mailing list discussion.
I don't feel that the title casing issues should block this PR from being merged, in the spirit of iterative releases.
|
||
Include other important information here too, such as known issues or bugs. | ||
Include other important information here, such as known issues or bugs. | ||
|
||
## Step-by-step guide | ||
|
||
### Step 1: Optional: Title for step - image or screenshot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### Step 1: Optional: Title for step - image or screenshot | |
### Step 1 (Optional): Title for step - image or screenshot |
What about this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor typos, and a number of minor suggestions which I suggest addressing.
|
||
## Get started | ||
|
||
## Step 1 - <One-sentence description of the step.> | ||
## Step 1 - One-sentence description of the step | ||
|
||
<!-- Fill in more details, as needed. --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While I think it was me who originally suggested putting writing instructions inside comments, we've since realized that many people look at these templates from the github website interface, were the comments are not rendered.
So we should move all these comments into some {text inside brackets} or similar. See what Alyssa has done with the style guide: https://github.com/thegooddocsproject/incubator/blob/master/style-guide/template-style-guide.md
This comment applies to other instances in this pull request.
Co-authored-by: Lana Brindley <[email protected]>
Co-authored-by: Cameron Shorter <[email protected]>
Co-authored-by: Lana Brindley <[email protected]>
Co-authored-by: Cameron Shorter <[email protected]>
Co-authored-by: Cameron Shorter <[email protected]>
Co-authored-by: Lana Brindley <[email protected]>
Co-authored-by: Cameron Shorter <[email protected]>
Co-authored-by: Cameron Shorter <[email protected]>
Co-authored-by: Cameron Shorter <[email protected]>
Co-authored-by: Cameron Shorter <[email protected]>
* about-overview * about-quickstart * api-quickstart * api-reference * about-explanation * template-explanation * removed dead link * about-api-reference * api-reference * about-how-to * template-how-to * consistency * about-logging * about-reference * about-tutorial * consistency * Update reference/about-reference.md Co-authored-by: Lana Brindley <[email protected]> * Update reference/about-reference.md Co-authored-by: Cameron Shorter <[email protected]> * Update tutorial/about-tutorial.md Co-authored-by: Lana Brindley <[email protected]> * Update tutorial/about-tutorial.md Co-authored-by: Cameron Shorter <[email protected]> * Update how-to/about-how-to.md Co-authored-by: Cameron Shorter <[email protected]> * Update api-reference/about-api-reference.md Co-authored-by: Lana Brindley <[email protected]> * Update explanation/about-explanation.md Co-authored-by: Cameron Shorter <[email protected]> * Update how-to/about-how-to.md Co-authored-by: Cameron Shorter <[email protected]> * Update how-to/about-how-to.md Co-authored-by: Cameron Shorter <[email protected]> * Update how-to/about-how-to.md Co-authored-by: Cameron Shorter <[email protected]> Co-authored-by: Jared Morgan <[email protected]> Co-authored-by: Cameron Shorter <[email protected]>
Fixes: #96
Purpose / why
End-to-end copyedit of all templates and their companion docs.
What changes were made?
Style and wording updates to meet GDSG standards
Verification
Please check for any typos or style issues that might have been introduced or missed.
Notes for reviewers
logging/template-logging.adoc
,reference/template-reference.adoc
, ortutorial/template-tutorial.adoc
as they need to be changed into markdown, and a lot of the content needs to be moved out of the template and into the companion doc. TODO: Create issues for this.Checklist