Rewrites to PlantUML page
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.
- 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.
- Re-flowed text into paragraphs containing multiple sentences, when possible.
- Put procedures into ordered lists, to make clear they are a list of steps.
- 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.
- A lot of rewriting for active voice, brevity, and tone.
Related issues
Closes #34082 (closed)
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have Developer permissions or higher:
-
Ensure that the product tier badge is added to doc's h1
. -
Apply the documentation label, plus: - The corresponding DevOps stage and group labels, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Assign the designated Technical Writer.
-
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:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add the product tier badge accordingly. -
Add GitLab's version history note(s). -
Add/update the feature flag section.
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. -
Ensure docs metadata are present and up-to-date. -
Ensure Technical Writing and documentation are added. -
Add the corresponding docs::
scoped label. -
If working on UI text, add the corresponding UI Text
scoped label. -
Add twdoing when starting work on the MR. -
Add twfinished if Technical Writing team work on the MR is complete but it remains open.
-
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
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.