Skip to content
Snippets Groups Projects

Move OpenAPI mention and link to doc first

Merged Marcin Sedlak-Jakubowski requested to merge msj-openapi into master
All threads resolved!

What does this MR do?

  • Move the OpenAPI link under REST API heading to clarify it's not another type of API, but it's the REST API in another format.
  • Link instead to the doc page that explains OpenAPI. You can get there from that page.

Related issues

Author's checklist

If you are 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.

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

Merged results pipeline #429880249 passed

Merged results pipeline passed for c63cbcea

Approved by

Merged by Kati PaizeeKati Paizee 3 years ago (Dec 15, 2021 6:50am UTC)

Merge details

  • Changes merged into master with 1486aa2c (commits were squashed).
  • Deleted the source branch.
  • Auto-merge enabled

Pipeline #429882584 passed

Pipeline passed for 1486aa2c on master

8 environments impacted.

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
Please register or sign in to reply
Loading