Deprecate use of id for vulnerabilityFindingDismiss mutation
Be sure to link this MR to the relevant issues.
- Deprecation issue: #360478 (closed)
- Removal issue:
- MR that removed (or will remove) the feature:
If there is no relevant deprecation issue, hit pause and:
- Review the process for deprecating and removing features.
- Connect with the Product Manager DRI.
Removals must be announced as deprecations at least 2 milestones in advance of the planned removal date.
If the removal creates a breaking change, it can only be removed in a major "XX.0" release.
By the 10th: Assign this MR to these team members as reviewers, and for approval:
- Required:
- Product Group Manager or Director:
@PM
- Engineering Manager:
@EM
- Technical writer:
@TW
- Product Group Manager or Director:
- Optional:
- Product Designer(s):
@ProductDesigners
- Product Marketing:
@PMM
- Product Designer(s):
By 7:59 PM UTC 15th (11:59 AM PT): EM/PM assigns this MR to the TW reviewer for final review and merge: @EM/PM
By 7:59 AM UTC 18th (11:59 PM PT 17th): TW Reviewer updates Docs by merging this MR to master
: @TW
Please review the guidelines for removals.
EM/PM release post item checklist
-
Set yourself as the Assignee, meaning you are the DRI. -
If the removal is a breaking change, add label breaking change
. -
Follow the process to create a removal YAML file. -
Add reviewers by the 10th. -
When ready to be merged and not later than the 15th, add the ~ready label and @ message the TW for final review and merge. - Removal notices should not be merged before the code is removed from the product. Do not mark ~ready until the removal is complete, or you are certain it will be completed within the current milestone and released. If PMs are not sure, they should confirm with their Engineering Manager.
Reviewers
When the content is ready for review, the Technical Writer and Engineering Manager must
review it. Optional reviewers can include Product Marketing, Product Design, and the Product Leaders
for this area. Use the
Reviewers for Merge Requests
feature for all reviews. Reviewers will approve
the MR and remove themselves from the reviewers list when their review is complete.
-
(Recommended) PMM -
(Optional) Product Designer -
(Optional) Group Manager or Director -
Required review and approval: Technical Writer designated to the corresponding DevOps stage/group.
Tech writer review
The TW should review according to the criteria listed below. Review a removal MR with the same process as regular docs MRs. Add suggestions as needed, @ message the PM to inform them the first review is complete, and remove yourself as a reviewer if it's not yet ready for merge.
Removal notices should not be merged before the code is removed from the product.
Expand for Details
-
Title: - Length limit: 7 words (not including articles or prepositions).
- Capitalization: ensure the title is sentence cased.
- Rewrite to exclude the words
removal
andremove
if necessary.
-
Consistency: - Ensure that all resources (docs, removal, etc.) refer to the feature with the same term / feature name.
-
Content: - Make sure the removal is accurate based on your understanding. Look for typos or grammar mistakes. Work with PM and PMM to ensure a consistent GitLab style and tone for messaging, based on other features and removals.
- Review use of whitespace and bullet lists. Will the removal item be easily scannable when published? Consider adding line breaks or breaking content into bullets if you have more than a few sentences.
- Make sure there aren't acronyms readers may not understand per https://about.gitlab.com/handbook/communication/#writing-style-guidelines.
-
Links: - All links must be full URLs, as the removal YAML files are used in multiple projects. Do not use relative links. The generated doc is an exception to the relative link rule and currently uses absolute links only.
- Make sure all links and anchors are correct. Do not link to the H1 (top) anchor on a docs page.
-
Code. Make sure any included code is wrapped in code blocks. -
Capitalization. Make sure to capitalize feature names. Stay consistent with the Documentation Style Guidance on Capitalization. -
Blank spaces. Remove unnecessary spaces (end of line spaces, double spaces, extra blank lines, and lines with only spaces).
When the PM indicates it is ready for merge and all issues have been addressed, start the merge process.
Technical writer merge process
The removals doc's .md
file
must be updated before this MR is merged:
- Check out the MR's branch (in the
gitlab-org/gitlab
project). - From the command line (in the branch), run
bin/rake gitlab:docs:compile_removals
. If you want to double check that it worked, you can runbin/rake gitlab:docs:check_removals
to verify that the doc is up to date. - Commit the updated file and push the changes.
- Set the MR to merge when the pipeline succeeds (or merge if the pipeline is already complete).
If you have trouble running the rake task, check the troubleshooting steps.
Merge request reports
Activity
added typemaintenance label
added groupthreat insights label and removed grouptesting label
Suggested Reviewers (beta)
The individuals below may be good candidates to participate in the review based on various factors.
You can use slash commands in comments to quickly assign
/assign_reviewer @user1
.Suggested Reviewers @rymai
,@aqualls
,@mwoolf
,@rpereira2
,@eread
If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue:
https://gitlab.com/gitlab-org/gitlab/-/issues/357923
.Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".
Edited by GitLab Reviewer-Recommender Botadded Technical Writing release post item release post itemremoval labels
requested review from @hbenson, @thiagocsf, and @claytoncornell
assigned to @matt_wilson
assigned to @thiagocsf
added breaking change label
@matt_wilson thanks for adding the breaking change label!
This merge request introduces breaking changes. Learn more about breaking changes.
It's important to identify how the breaking change was introduced. To estimate the impact, try to assess the following:
- Are there existing users depending on this feature?
- Are self-managed customers affected?
- To verify and quantify usage, use Grafana or Kibana.
- If you're not sure about how to query the data, contact the infrastructure team on their Slack channel, #infrastructure-lounge
- Was sufficient time given to communicate the change?
- Changes in the permissions, the API schema, and the API response might affect existing 3rd party integrations.
- Reach out to the Support team or Technical Account Managers and ask about the possible impact of this change.
- Are there existing users depending on this feature?
marked the checklist item If the deprecation is a breaking change, add label
breaking change
. as completedmarked the checklist item Follow the process to create a deprecation YAML file. as completed
@jschafer Would appreciate you giving the removal description in the yaml a once over to make sure I've accurately captured the what and why of the deprecation.
- Resolved by Thiago Figueiró
👋 @jschafer
, thanks for approving this merge request.This is the first time the merge request is approved. To ensure full test coverage, a new pipeline has been started.
For more info, please refer to the following links:
changed milestone to %15.2
mentioned in issue #367166 (closed)
unassigned @thiagocsf
- Resolved by Clayton Cornell
Thanks for writing this, @matt_wilson. I only had one suggestion. Approving.
removed review request for @thiagocsf
- A deleted user
added documentation label
1 Message 📖 This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/update/deprecations.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
🔁 danger-review
job that generated this comment.Generated by
🚫 Dangeradded 1 commit
- 817594df - Update syntax heading and recompile deprecation
marked the checklist item Capitalization. Make sure to capitalize feature names. Stay consistent with the Documentation Style Guidance on Capitalization. as completed
@matt_wilson Reviewed and made some text changes. Recompiled the topics etc. and it all looks OK from my side.
changed milestone to %15.3
mentioned in merge request gitlab-com/www-gitlab-com!108820 (merged)
- Resolved by Matt Wilson
- Resolved by Matt Wilson
added Ready label
- Resolved by Clayton Cornell
@claytoncornell This one is also ready for your merge. I updated the deprecation announcement milestone to 15.3 and announcement date to match.
- Resolved by Clayton Cornell
@matt_wilson with this one... do you think maybe we should rename the file as well so that everything lines up... 15.3 in filename and 15.3 in the contents? It could save future confusion.
added 1 commit
- b0f160a9 - Deprecate use of id for vulnerabilityFindingDismiss mutation
added 5636 commits
-
b0f160a9...a43b4409 - 5635 commits from branch
master
- 3d0802a1 - Deprecate use of id for vulnerabilityFindingDismiss mutation
-
b0f160a9...a43b4409 - 5635 commits from branch
mentioned in commit 1ddf6ce5
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
removed documentation label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
added releasedcandidate label
added devopsgovern label and removed devopssecure label