Deprecation notice for Live Preview
Be sure to link this MR to the relevant deprecation issue(s).
- Deprecation Issue: #383889 (closed)
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: @heather
- Product Designer(s):
@ProductDesigners
- Product Group Manager or Director: @sarahwaldner
- Engineering Manager: @oregand
- Technical writer: @ashrafkhamis
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
. -
Follow the process to create a deprecation YAML file. -
Make sure that the milestone dates are based on the dates in Product milestone creation. -
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.
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 for Merge Requests
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 @ericschurter
changed milestone to %15.8
added sectiondev label
2 Warnings b45a66ea: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines. b45a66ea: The commit subject must start with a capital letter. For more information, take a look at our Commit message guidelines. 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-
- Resolved by Eric Schurter
@ashrafkhamis FYR - this deprecation notice is about the Live Preview feature that we intend to remove ASAP.
requested review from @ashrafkhamis
- Resolved by David O'Regan
@brhea Question for you on this deprecation notice. As outlined in #383889 (closed) we have very low usage of Live Preview and we have approval to remove it out of band in a minor release.
However, this is the first time we'd be mentioning the removal outside of an issue. I'm curious if you feel we should wait until 15.9 to actually remove the code? Maybe we could remove the code after Jan 17th so that self-managed instances will only be impacted in 15.9?
cc @oregand for timing of the related MR
- A deleted user
added documentation label
added breaking change label
@brhea 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?
@sarahwaldner
, 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
marked the checklist item Capitalization. Make sure to capitalize feature names. Stay consistent with the Documentation Style Guidance on Capitalization. as completed
- Resolved by Eric Schurter
- Resolved by Eric Schurter
- Resolved by Eric Schurter
- Resolved by Eric Schurter
- Resolved by Eric Schurter
- Resolved by Eric Schurter
- Resolved by Eric Schurter
added docsimprovement maintenanceremoval labels
removed review request for @ashrafkhamis
requested review from @ashrafkhamis
mentioned in merge request !108512 (merged)
- Resolved by Ashraf Khamis
- Resolved by Ashraf Khamis
removed review request for @ashrafkhamis
marked the checklist item Required review and approval: Technical Writer designated to the corresponding DevOps stage/group. as completed
added 872 commits
-
827d600c...87cf9dfc - 862 commits from branch
master
- 03ea2d73 - Deprecation notice for Live Preview
- 5796fc3f - Compile the deprecations page
- ec8b12b5 - Fix pipeline lint error
- c763841e - Remove trailing whitespace
- 9a8b9039 - Tweaks to milestones and description
- b45a66ea - docs update
- 782c0833 - Update deprecations file
- 3a54e04c - Enclose removal date in double quotes
- 1d394b20 - Test pipeline fix
- 079b12c3 - Regenerate deprecation file
Toggle commit list-
827d600c...87cf9dfc - 862 commits from branch
added Ready label
assigned to @ashrafkhamis
requested review from @eread
@eread, did you forget to run a pipeline before you merged this work? Based on our code review process, if the latest pipeline was created more than 6 hours ago, and finished more than 2 hours ago, you should:
- Ensure the merge request is not in Draft status.
- Start a pipeline (especially important for Community contribution merge requests).
- Set the merge request to merge when pipeline succeeds.
This is a guideline, not a rule. Please consider replying to this comment for transparency.
This message was generated automatically. You're welcome to improve it.
mentioned in commit 52a302f8
added rp manager reviewed label
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-production label and removed workflowproduction label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label