Skip to content

Edited instructions for style compliance

Russell Dickenson requested to merge russell/fix-min-password-instructions into master

What does this MR do?

Fixes several issues with the current documentation:

  • Adds GitLab version information to the individual bullet points.
  • Fixes the markup format of an image.
  • Reorders the procedures so that the only currently valid method is listed first.
  • Moves the content of the admonition to the introduction to make it more noticeable.
  • Edits instructions to comply with the docs style guide.

Before:

https://docs.gitlab.com/ee/security/password_length_limits.html#modify-minimum-password-length-using-gitlab-ui

After:

https://gitlab.com/gitlab-org/gitlab/-/blob/a020d065d464a3059c835d554c223ff01596992c/doc/security/password_length_limits.md

Related issues

N/A

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 Russell Dickenson

Merge request reports

Loading