Skip to content

Update writing style guidelines with correct capitalization for self-managed

Nuritzi Sanchez requested to merge nuritzi-master-patch-23928 into master

Why is this change being made?

There has been confusion about the correct capitalization of "self-managed". After a slack conversation with @bmatturro from the Content Marketing team, my understanding is that "self-managed" should not be capitalized at all unless it's part of a title. In that case, it should be "Self-Managed".

This MR updates the current Writing Style Guidelines handbook page with this clarification around capitalization.

This MR also groups together the capitalization bullet point with a bullet point (currently No. 30) about the fact that we refer to self-hosted instances as "on-premises" or "self-managed". We may want to further update that bullet point if we decide to only call it "self-managed" for further consistency. Or, we may want to clarify that our product name only includes "self-managed" terminology.

Author Checklist

  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the "Maintained by" section in on the page being edited.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
    • If the changes relate to any part of the project other than updates to content and/or data files please make sure to ping @gl-static-site-editor in a comment for a review and merge. For example changes to .gitlab-ci.yml, JavaScript/CSS/Ruby code or the layout files. (this requirement has been removed pending identification of a new DRI for the handbook)

Merge request reports