Update details about text formatting
What does this MR do?
This MR combines all the typographic details in the style guide into a new ## Text formatting
section. They were scattered around the page and could use better headers, so now they are all collated together, and all follow a similar pattern to make it easier to follow. The examples are also standardized to better represent the expected usage and formatting.
Copy edits
-
Clarify details about bold and backticks with better examples.
-
Use both rendered examples, along with code blocks that demonstrate the markdown formatting.
-
Recommend avoiding both italics and quotes, along with moving quotes section to punctuation, and moving
<kbd>
text formatting to the new text formatting section. -
For quotes, explaining to use the British/International style for quotes with punctuation:
Put commas and periods outside the quotation marks unless the quotation is also a complete sentence or the punctuation is part of the quotation.
As shown in the majority of pages, this is already our standard, for example:
- https://gitlab.com/gitlab-org/gitlab/-/blob/a535cfcb9cb6d765cbb6c2e711bd2dc0df930482/doc/ci/migration/jenkins.md#L76
- https://gitlab.com/gitlab-org/gitlab/-/blob/a535cfcb9cb6d765cbb6c2e711bd2dc0df930482/doc/ci/pipelines/downstream_pipelines.md#L34
- https://gitlab.com/gitlab-org/gitlab/-/blob/a535cfcb9cb6d765cbb6c2e711bd2dc0df930482/doc/ci/yaml/yaml_optimization.md#L323
-
This also cleans up some non-standard ("curly") quotation marks, but without looking too closely as to whether or not the quotes can be removed.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.