Skip to content

Clean up API page for repositories

Amy Qualls requested to merge aqualls-repositories-api-cleanup into master

What does this MR do?

Another in my series of "clean up API pages for my groups" MRs that I'm doing in my free time. This page, unfortunately, has problems. Some unsourced deprecation statements need more info.

A commit list will help the diff be more readable:

  • !99128 (0100b864) re-alphabetizes rows with no changes to their content
  • !99128 (28b61afd) fixes line wrapping with no changes to the wording
  • !99128 (9b98c165) is where it starts getting interesting. Clean up the content. Attempt to re-format deprecation statements and source info for them.

Related issues

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.
Edited by Amy Qualls

Merge request reports

Loading