Point to Pajamas for additional punctuation guidelines
What does this MR do?
Currently, this MR crosslinks https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation-1 with the Pajamas guide for punctuation. (https://design.gitlab.com/content/punctuation/).
However, when the work is completed - here's where I need @mikelewis to weigh in - it should also settle an edge case in our punctuation rules:
In discussing !19691 (merged) with @rdickenson, he noted that the UI strings were mostly sentence fragments (requiring no ending punctuation) but two of the items in the list were complex enough to contain a full sentence AND a following fragment.
In the case that spawned the issue, we had a set of form fields. Most of the items were self-explanatory, but 1-2 fields required a much longer explanation, like this:
- (name field) Name
- (date field) Date
- (Limit size) Leave blank for no limit. Once set, a token can be revoked
In such a case, where most items are (legitimately) fragments, but one item is significantly more complex, which punctuation approach is correct?
- Rewrite the fragment into a second full sentence, AND punctuate all other items on the list even though they're fragments
- Leave the trailing fragment AND all other fragments unpunctuated (TBH this is my pick even though it's somewhat non-standard)
- Some other option I haven't thought of
I'm assigning this MR to Mike in the hopes of the style committee settling it.
Related issues
Closes technical-writing#83 (closed)
Related to #232555 (closed) where Mike Lewis will bring it to the style committee.
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have
developer
access or higher (for example, GitLab team members or Core Team members)-
Apply the documentation label, plus: - The corresponding DevOps stage and group label, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Assign the designated Technical Writer.
-
Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.
When applicable:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add GitLab's version history note(s). -
Add the product tier badge. -
Add/update the feature flag section. -
If you're changing document headings, search doc/*
,app/views/*
, andee/app/views/*
for old headings replacing with the new ones to avoid broken anchors.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. -
Add Technical Writing and docs::
workflow label. -
Add docs-only when the only files changed are under doc/*
. -
Add twdoing when starting work on the MR. -
Add twfinished after approving and/or merging the MR.
-
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.