Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Copy Edit #162

Merged
merged 26 commits into from
Oct 28, 2020
Merged

Copy Edit #162

merged 26 commits into from
Oct 28, 2020

Conversation

Loquacity
Copy link
Member

@Loquacity Loquacity commented Oct 24, 2020

ALL Pull-Requests require an associated Issue as documented in How to contribute.

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

  • I have not edited logging/template-logging.adoc, reference/template-reference.adoc, or tutorial/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.
  • We have lots of different terms for the people reading the docs created with the templates, I have standardised on "reader" where it's obvious it's the person reading the document created with the template, but have left it as "user" if it's specific to someone using a product (as opposed to reading a doc). TODO: As a group, do we agree with this? Document this choice.
  • I have standardised across the various documents a fair bit (eg: "the overview section" in the companion docs), but please point out any internal inconsistencies you notice. TODO: Should we consider using snippets/content reuse for stuff that is repeated frequently?

Checklist

Pull-request reviewer should ensure the following

  • Are issues linked correctly?
  • Is this PR labeled correctly?
  • If template updates: do they align with developers.google.com/style/?
  • Did the PR receive at least one 👍 and no 👎 from core-maintainers?
  • On merging, did you complete the merge using keywords?
  • On merging, did you add any applicable notes to a draft release and link to this PR?

@Loquacity Loquacity changed the title Copyedit lbrindley Copy Edit Oct 24, 2020
@Loquacity Loquacity self-assigned this Oct 24, 2020
@Loquacity Loquacity marked this pull request as ready for review October 24, 2020 06:08
Copy link
Contributor

@jaredmorgs jaredmorgs left a 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.

api-quickstart/about-quickstart.md Show resolved Hide resolved
api-reference/about-api-reference.md Outdated Show resolved Hide resolved
explanation/about-explanation.md Show resolved Hide resolved
explanation/about-explanation.md Show resolved Hide resolved
explanation/template-explanation.adoc Show resolved Hide resolved
how-to/about-how-to.md Show resolved Hide resolved
how-to/template-how-to.md Show resolved Hide resolved
reference/about-reference.md Show resolved Hide resolved
reference/about-reference.md Outdated Show resolved Hide resolved
tutorial/about-tutorial.md Outdated Show resolved Hide resolved
tutorial/about-tutorial.md Outdated Show resolved Hide resolved

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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Step 1: Optional: Title for step - image or screenshot
### Step 1 (Optional): Title for step - image or screenshot

What about this?

Copy link
Member

@camerons camerons left a 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. -->
Copy link
Member

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.

explanation/about-explanation.md Outdated Show resolved Hide resolved
how-to/about-how-to.md Outdated Show resolved Hide resolved
how-to/about-how-to.md Outdated Show resolved Hide resolved
how-to/about-how-to.md Outdated Show resolved Hide resolved
reference/about-reference.md Show resolved Hide resolved
tutorial/about-tutorial.md Show resolved Hide resolved
tutorial/about-tutorial.md Show resolved Hide resolved
tutorial/about-tutorial.md Outdated Show resolved Hide resolved
tutorial/about-tutorial.md Show resolved Hide resolved
@jaredmorgs jaredmorgs merged commit 315eb3a into master Oct 28, 2020
@Loquacity Loquacity deleted the copyedit-lbrindley branch October 28, 2020 10:12
camerons added a commit to camerons/templates that referenced this pull request Feb 27, 2021
* 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]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Let's have a copy edit
3 participants