Skip to content

Swap remaining Code Owners image to Mermaid

Amy Qualls requested to merge aqualls-codeowner-image2 into master

What does this MR do?

In !92818 (merged) I replaced the first of two images in https://docs.gitlab.com/ee/user/project/code_owners.html#groups-as-code-owners with a Mermaid graph. Let's do the second -- trickier -- one.

Before

code_owners_invite_members_v13_4

After (in progress)

Observations:

  • I took out Project B. I think it's extraneous here.
  • conveying the decision points requires me to break standard formatting somewhat, because we're not interested in the no outcomes for the two options.
  • would it be clearer to change the phrasing to Invite subgroup Y to Project A? and Add subgroup Y as Code Owners for project A? Length vs clarity, discuss!
graph LR
    A[Parent group X] -->|owns| B[Project A]
    A -->|contains| C[Subgroup Y]
    C -.->D{Invite to<br/>Project A?} -.->|Approvals can be<br/> required or optional| B
    C -.->E{Add as Code Owners<br/>to Project A?} -.->|Approvals can only<br/>be optional| B

Related issues

Related to Swap codeowner image out for Mermaid diagram (!92818 - merged)

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 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 Amy Qualls

Merge request reports

Loading