Add GraphQL styleguide for sort enums
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
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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
Activity
added docsimprovement documentation maintenancerefactor typemaintenance labels
assigned to @.luke
changed milestone to %16.10
added GraphQL groupimport and integrate labels
added devopsmanage sectioncore platform labels
- Resolved by Evan Read
Hi @eread! Could you please give this MR its Technical Writing review? Thank you!
requested review from @eread
- A deleted user
added development guidelines label
1 Message This MR contains docs in the /development directory. Any Maintainer, other than the author, can merge. You do not need tech writer review. If needed, you can retry the
danger-review
job that generated this comment.Generated by
Dangeradded docs-only label
- Resolved by Evan Read
Hi
@eread
,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.
added Technical Writing label
reset approvals from @eread by pushing to the branch
enabled an automatic merge when the pipeline for df863423 succeeds