Skip to content

General style cleanup for LDAP page

Craig Norris requested to merge docs-ldap-general-update into master

What does this MR do?

This MR makes several style and tone updates to the General LDAP setup page, including:

  • Removes Overview section, and incorporates its info into the introductory section of the page.
  • Replaces several instances of "via" in the doc.
  • Table updates, for spacing and to implement Style Guide standards for "yes" or "no" cells.
  • Some formatting and punctuation changes in lists and tables, for parallelism.
  • A bit of information removal or reformatting in some places, for SSOT purposes.
  • Removed some instances of "please" and "as well as".
  • Style refresh, to get the page's content closer to our current Style Guide implementation.

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 Craig Norris

Merge request reports

Loading