Draft: Remove API/GraphQL deprecations that are already documented
What does this MR do?
As documented in a few places, GraphQL and API deprecations are documented in their relevant docs/references, not in the deprecations page:
-
https://docs.gitlab.com/ee/update/deprecations.html
REST API deprecations and GraphQL deprecations are documented separately.
-
https://docs.gitlab.com/ee/development/documentation/styleguide/deprecations_and_removals.html
A separate process exists for GraphQL docs and REST API docs.
As a result, we should remove these from the main deprecation page, to maintain a SSoT.
Removed deprecation entries
| File | In GraphQL/Rest deprecation docs? |
|---|---|
| 14-5-runner-api-status-does-contain-paused.yml | Yes and Yes |
| 14-8-graphql-runner-active.yml | Yes |
| 15-8-deprecate-disabled-with-override-runner-setting-value.yml | Yes |
| 15-9-deprecate-runner-setup-instructions-api.yml | Yes |
| 16-0-graphql-RunnerMembershipFilter-renamed.yml | Yes |
| 16-2-cirunner_fields.yml | Yes and Yes |
| 17-5-deprecate-ciUsedMinutes-graphql-field.yml |
Yes, and deprecation doc incorrect anyways: ciUsedMinutes != ciMinutesUsed
|
Related issues
Resolves #509889 (closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details 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.