Skip to content

Push rules: first round of changes

Amy Qualls requested to merge aqualls-push-rules-1 into master

What does this MR do?

This merge request is the first of several to start polishing the https://docs.gitlab.com/ee/user/project/repository/push_rules.html page, which is a mess:

  • Shift 2-column table into unordered list with key / value pairs.
  • Polish that section only.
  • Split apart into checkbox rules and regex-required rules for ease of explanation.
  • Create a new subheading for default rules. Move it, and the subheading for custom rules, to the top of the page.

More work is needed. DO NOT review unchanged portions of this page. I'm trying to keep these merge requests from becoming painful to review.

Related issues

Related to technical-writing#531 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports

Loading