Skip to content

Merge request API page: start cleanup

Amy Qualls requested to merge 433318-aqualls-initial-formatting into master

What does this MR do?

As part of the more technical work that needs to happen for #433318, let's start by fixing stylistic issues that will become problematic a step or two down the line.

I suspect this diff will be ugly, so here's what each commit does:

  • !138427 (fd4b23db) Stylistic fixes:
    • takes out (most †) references to GitLab 13 and earlier
    • s/read/see
    • Adds Example response: to explain that something is a response, instead of implying it
    • Reunites some standalone sentences with the line in the table they belong to
    • Changes some future tense (will do X) to present tense (does X)
    • Fixes instances of via
    • Moves response info to correct places in subheads
  • !138427 (995d703c) Rewrites: this commit takes more freestanding sentences and blends them into the appropriate line of the attribute table, or moves the statements to the right place for response-related info. I expect that if I introduced problems or inaccuracies, it's in this commit.
  • !138427 (c6475981) Stylistic fixes: change all curl commands to use the multi-line format.

† There are two GitLab 12 references that are unfortunately still relevant and need to stay.

I'll leave questions and points of concern for my tech reviewer in a separate comment or two.

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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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