Skip to content

Post-merge-review: composition API developer docs

Amy Qualls requested to merge 365767-aqualls-post-merge-review into master

What does this MR do?

Add frontend guidelines regarding Composition API (!90689 - merged) merged without a technical writer seeing it, so I'm doing a quick post-merge review to clean up some style issues on the page. This merge request is NOT a full tone and style edit - just a light polish. Adds composables to the custom dictionary. We had the singular form (composable) but not the plural.

Reviewers:

  • @slashmanov because he reviewed the changes from a technical perspective. Make sure I didn't screw up your words!
  • @phillipwells because you're a shiny new member of the Technical Writing team, and this merge request does not require deep knowledge of our platform. Work with @claytoncornell to merge this MR after resolving any concerns you & Stas have.

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.

Merge request reports