Adds deprecation note for sidekiq delivery method for mailroom
Be sure to link this MR to the relevant deprecation issue(s).
- Deprecation Issue: Deprecate sidekiq delivery method for email ing... (#398132)
If there is no relevant deprecation issue, hit pause and:
- Review the process for deprecating and removing features.
- Connect with the Product Manager DRI.
Deprecation announcements can and should be created and merged into Docs at any time, to optimize user awareness and planning. We encourage confirmed deprecations to be merged as soon as the required reviews are complete, even if weeks ahead of the target milestone's release post. For the announcement to be included in a specific release post and that release's documentation packages, this MR must be reviewed/merged per the due dates below:
By the 10th: Assign this MR to these team members as Reviewer and for Approval (optional unless noted as required):
- Product Marketing:
@PMM
- Product Designer(s):
@ProductDesigners
- Product Group Manager or Director: @kbychu - Required
- Engineering Manager: @francoisrose - Required
- Technical writer: @msedlakjakubowski - Required
By 11:59 AM PDT 15th: EM/PM assigns this MR to the TW reviewer for final review and merge: @EM/PM
By 11:59 PM PDT 17th: TW Reviewer updates Docs by merging this MR to master
: @TW
Please review:
- The definitions of "Deprecation", "End of Support", and "Removal".
- The guidelines for deprecations.
- The process for creating a deprecation entry.
They are frequently updated, and everyone should make sure they are aware of the current standards (PM, PMM, EM, and TW).
EM/PM release post item checklist
-
Set yourself as the Assignee, meaning you are the DRI. -
If the deprecation is a breaking change, add label breaking change
. -
Confirm this MR is labeled release post itemdeprecation -
Follow the process to create a deprecation YAML file. -
Add reviewers by the 10th. -
Add scoped devops::
andgroup::
labels as necessary. -
Add the appropriate milestone to this MR. -
When ready to be merged (and no later than the 15th) @mention
the TW for final review and merge.
Reviewers
When the content is ready for review, it must be reviewed by a Technical Writer and Engineering Manager, but can also be reviewed by
Product Marketing, Product Design, and the Product Leaders for this area. Please use the
reviewers
feature for all reviews. Reviewers will then approve
the MR and remove themselves from Reviewers 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
After being added as a Reviewer to this merge request, the TW performs their review according to the criteria described below.
Review deprecation MRs with a similar 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 ready for merge yet.
Expand for Details
-
Title: - Length limit: 7 words (not including articles or prepositions).
- Capitalization: ensure the title is sentence cased.
-
Dates: - Make sure that the milestone dates are based on the dates in Product milestone creation.
-
Consistency: - Ensure that all resources (docs, deprecation, etc.) refer to the feature with the same term / feature name.
-
Content: - Make sure the deprecation 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 deprecations.
- Review use of whitespace and bullet lists. Will the deprecation 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 deprecation YAML files are used in two different 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 deprecations 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_deprecations
. If you want to double check that it worked, you can runbin/rake gitlab:docs:check_deprecations
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
assigned to @msaleiko
@msaleiko 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.
This message was generated automatically. You're welcome to improve it.
- Are there existing users depending on this feature?
marked the checklist item Confirm this MR is labeled release post itemdeprecation as completed
marked the checklist item Follow the process to create a deprecation YAML file. as completed
added devopsmonitor grouprespond labels
added sectionops label
changed milestone to %16.0
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Dangerrequested review from @kbychu
@kbychu
could you do the initial review for the deprecation entry forsidekiq
delivery method. I don't know how much context we need to provide or whether it should stay short.Additionally I realized that we don't have the delivery methods documented in the user documentation a lot. It's spread all over the place and you really need to look for that. I have [this MR about multi-node setups] that adds some documentation about it, but it's still in review.
added 1 commit
- 9924cda7 - Adds deprecation note for sidekiq delivery method for mailroom
mentioned in issue #398132
added IncubationService Desk label
- Resolved by Marc Saleiko
- Resolved by Marc Saleiko
mentioned in issue gitlab-org/incubation-engineering/service-desk/meta#12
- Resolved by Marc Saleiko
mentioned in issue gitlab-org/incubation-engineering/service-desk/meta#3
mentioned in issue gitlab-org/quality/triage-reports#12337 (closed)
added 5383 commits
-
9924cda7...1550cf95 - 5382 commits from branch
master
- e3e47504 - Adds deprecation note for sidekiq delivery method for mailroom
-
9924cda7...1550cf95 - 5382 commits from branch
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
(Link to current live version)
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
Danger-
added 1 commit
- 16baf456 - Apply review suggestions and add more details
added 1 commit
- b46792c3 - Apply review suggestions and add more details
requested review from @cleveland
requested review from @msedlakjakubowski
- Resolved by Marc Saleiko
@msedlakjakubowski
this MR adds the deprecation note for the sidekiq delivery method for mail_room. Because we do not have much documentation about this specific area available (we talked about improving that later), I tried to be very detailed about what it is, how each method works and why we deprecate thesidekiq
delivery method.Could review this please?
Sorry for the late noticeAfter we have approvals, I think you'd need to take over that MR, right? I don't know how that works for deprecations, yet.
@cleveland
, thanks for approving this merge request.This is the first time the merge request is approved. To ensure full test coverage, a new pipeline will be started shortly.
For more info, please refer to the following links:
added pipeline:mr-approved label
- Resolved by Marc Saleiko
- Resolved by Marcin Sedlak-Jakubowski
added 394 commits
-
0e41dac4...9b0df76e - 389 commits from branch
master
- 1dd59570 - Adds deprecation note for sidekiq delivery method for mailroom
- 21cd4bfe - Apply review suggestions and add more details
- 2f196eb3 - Adds wording review suggestions
- b0da3dc1 - Trim a comment
- 5a052a97 - Regenerate deprecation docs and trim whitespace
Toggle commit list-
0e41dac4...9b0df76e - 389 commits from branch
- A deleted user
added documentation label
requested review from @francoisrose and removed review request for @msedlakjakubowski, @kbychu, and @cleveland
- Resolved by Marc Saleiko
- Resolved by Marc Saleiko
@msaleiko LGTM
Just added a suggestion to fix a broken docs link.