Skip to content

Standardize disclaimer in blueprints

Marcel Amirault requested to merge docs-blueprints-warnings into master

What does this MR do?

In #263404 (comment 1164719872), @susantacker noticed some inconsistency with the disclaimers in blueprint docs. I went through and standardized them all, based on the disclaimer at: https://docs.gitlab.com/ee/development/documentation/versions.html#legal-disclaimer-for-future-features

  • Copied the disclaimer exactly as written in the style guide and updated any that did not match.
  • For any pages that didn't have any disclaimer at all, I added it to the top of the page.
  • Moved any other disclaimers to the top of the page.
  • Updated the template with instructions to add the disclaimer to all new pages.
  • Fixed the "introduced in" formatting in two places.

A handful also had some whitespace warnings and non-standard em-dashes instead of hyphens, so I cleared that up as well.

Related issues

Related to #263404 (closed)

Author's checklist

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.
Edited by Marcel Amirault

Merge request reports