Skip to content

Rewrites to PlantUML page

Amy Qualls requested to merge 34082-aqualls-plantuml into master

What does this MR do?

#34082 (closed) was created to request some fixes to the PlantUML integration page at https://docs.gitlab.com/ee/administration/integration/plantuml.html. While there, I realized I should do a larger cleanup, because the page needed some extra attention.

I'm cc'ing @danielgruesso because this page falls under devopscreate groupsource code. Daniel, if you want to focus on the first commit you can confirm it handles the problem identified in #34082 (closed). Also, look for any facts I might've misplaced. Feel free to have opinions on style, but don't feel compelled to dig in on style issues; I've got @cnorris for that.

  1. Added a numbered procedure at the top of the page that points to the subheadings, which are the major steps to take in integrating PlantUML with GitLab.
  2. Re-flowed text into paragraphs containing multiple sentences, when possible.
  3. Put procedures into ordered lists, to make clear they are a list of steps.
  4. Rearranged the order of the page. I put the explanation of how to use the diagrams near the top of the page, because I think it's the real reason most people will visit this page. The installation instructions can sit lower down, because they're cross-linked from the top of the page.
  5. A lot of rewriting for active voice, brevity, and tone.

Related issues

Closes #34082 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Amy Qualls

Merge request reports

Loading