Skip to content

Exclude architecture docs from TW review

Marcel Amirault requested to merge docs-team-blueprint-reviews into main

Why is this change being made?

Related to gitlab-org/gitlab!145207 (comment 1780491857), we probably shouldn't recommend architecture docs get a TW review. As mentioned in that discussion:

Solutions docs and Development docs are not reviewed by technical writers, and:

On the other hand, blueprint docs:

  • Are not in the navigation
  • Are not useful to external users as these are forward looking planning docs that frequently get updated as plans change.
  • Have a warning on them that users should not rely on the information contained in them: https://docs.gitlab.com/ee/architecture/blueprints/cells/

Following this logic, TWs should not need to be involved in blueprint doc reviews, unless someone is struggling with language and looking for some extra help.

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (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 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
    • The when to get approval handbook section explains the workflow in more detail
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR

Merge request reports