Skip to content
Snippets Groups Projects

Add GraphQL styleguide for sort enums

Merged Luke Duncalfe requested to merge ld-docs-graphql-sort-enum-styleguide into master

What does this MR do?

This adds style guide information for sort arguments in GraphQL. See Slack thread (internal, good for 90 days).

The information is based on current practices but just formalises it in writing.

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 Luke Duncalfe

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Evan Read approved this merge request

    approved this merge request

  • Hi @eread :wave:,

    GitLab Bot has added the Technical Writing label because a Technical Writer has approved or merged this MR.

    This message was generated automatically. You're welcome to improve it.

  • Evan Read resolved all threads

    resolved all threads

  • Evan Read added 1 commit

    added 1 commit

    • b1f3f1c4 - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • Evan Read reset approvals from @eread by pushing to the branch

    reset approvals from @eread by pushing to the branch

  • Evan Read resolved all threads

    resolved all threads

  • Evan Read enabled an automatic merge when the pipeline for df863423 succeeds

    enabled an automatic merge when the pipeline for df863423 succeeds

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading