Update documentation style guide to codify some new standards

What does this MR do?

Updates the Documentation guidelines for to codify some rules developed in recent MRs:

• Guidance for handling offerings in REST API docs.
• Require periods on full sentences in tables.

Author's checklist

• Optional. Consider taking the GitLab Technical Writing Fundamentals course.
• Follow the:
  • Documentation process.
  • Documentation guidelines.
  • Style Guide.
• If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added.
• 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 like Default behavior when you close an issue.
    • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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.

changed milestone to %16.9

added Documentation guidelines Technical Writing docsimprovement documentation maintenancerefactor typemaintenance labels

assigned to @eread

	1 Message
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/development/documentation/styleguide/index.md (Link to current live version)
• doc/development/documentation/restful_api_styleguide.md (Link to current live version)

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

@sselhorn Could you review?

requested review from @sselhorn

added docs-only label

changed title from Update documentation style guide to codified some new standards to Update documentation style guide to codify some new standards

resolved all threads

added 1 commit

• 4b3e287e - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

approved this merge request

enabled an automatic merge when all merge checks for 4b3e287e pass

@eread I applied a suggestion and set to merge. Thanks for following up. (I'd written some of the language and when I went back to read it, I confused myself. So applied a suggestion.)

merged

mentioned in commit bc1c5965

resolved all threads

added workflowstaging-canary label

added workflowcanary label and removed workflowstaging-canary label

added workflowstaging label and removed workflowcanary label