Skip to content

Tidy up Search API page

Amy Qualls requested to merge aqualls-search-api-tidying into master

What does this MR do?

Several passes through doc/api/search.md to bring it closer to current spec. Most of these API-cleanup MRs have been quick snacks between meetings; this one was longer and I have some procedural questions I want to resolve during editorial review.

This work is easier to scan as separate commits:

  • !98475 (0718c9e3) fixes table sorting. No text changes, just alphabetization.
  • !98475 (4d1f37de) fixes the appearance of yes / no in columns.
  • !98475 (b7be95d6) takes out a lot of the excessive line spacing.
  • !98475 (b2e6f8a8) here's the real work! Line edits to individual rows in the tables, plus changes before / after tables when applicable.

Related issues

Related to Additional work needed on the Search API page (#375168) created as a follow-up for the groupglobal search TW.

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