Skip to content

Clarify final reconfigure/restart steps for GitLab integration

Craig Norris requested to merge docs-gitlab-restart-step into master

What does this MR do?

This MR attempts to provide clarity about whether the user should reconfigure or restart GitLab as the final step of their integration process. If this wording works, it may be worth revisiting the other integration pages to use this wording for consistency and to ensure we have helpful wording in place throughout.

I also made a couple of slight revisions on a couple of the preceding steps, to better indicate that they were command line values, and revised the follow-on paragraph after the process, for some cleanup and right-hand spacing (but no content changes).

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.

Merge request reports

Loading