Skip to content

Improving protect repository branches API documentation

Mitar requested to merge mitar/gitlab:doc-push_access_level into master

What does this MR do?

It fixes the type for push_access_level, merge_access_level, and unprotect_access_level, it should be integer.

It adds inline what is the expected form of a hash for allowed_to_push, allowed_to_merge, and allowed_to_unprotect. It is mentioned later on, but I find it more useful if we show it immediately. It took me some time to understand it without this.

Review 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.
    • 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.
  • Ensure a release milestone is set.

Merge request reports

Loading