Update MR template and edit deprecation files for new standard
What does this MR do?
Following on from: gitlab-com/www-gitlab-com!97139 (merged). Puts standard into practice.
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are 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.
Review 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 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. - 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. -
Ensure a release milestone is set.
Merge request reports
Activity
added documentation typemaintenance labels
assigned to @eread
changed milestone to %14.8
added Technical Writing docsimprovement release post labels
- Resolved by Evan Read
2 Messages CHANGELOG missing: If you want to create a changelog entry for GitLab FOSS, add the
Changelog
trailer to the commit message you want to add to the changelog.If you want to create a changelog entry for GitLab EE, also add the
EE: true
trailer to your commit message.If this merge request doesn't need a CHANGELOG entry, feel free to ignore this 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
doc/user/application_security/dependency_scanning/analyzers.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.
Reviewer roulette
There are no reviewer and maintainer suggestions for the changes in this MR.
Uncategorized files
These files couldn't be categorized, so Danger was unable to suggest a reviewer. Please consider creating a merge request to add support for them.
data/deprecations/14-0-nfs-fot-git-repository-storage.yml
data/deprecations/14-5-deprecate-convert-instance-runner-to-project.yml
data/deprecations/14-5-deprecate-defaultMergeCommitMessageWithDescription-graphql.yml
data/deprecations/14-5-deprecate-sles-12sp2.yml
data/deprecations/14-5-deprecation-versions-packagetype.yml
data/deprecations/14-5-geo-deprecate-promote-db.yml
data/deprecations/14-5-geo-deprecate-promote-to-primary-node.yml
data/deprecations/14-5-remove-dependency-proxy-permissions-flag.yml
data/deprecations/14-5-remove-pipelines-from-version-field.yml
data/deprecations/14-6-deprecate-types.yml
data/deprecations/14-6-deprecation-license-compliance-api-terms.yml
data/deprecations/14-6-deprecation-secure-dependency-scanning-bundler-audit.yml
data/deprecations/14-6-pipeline-fields-package-deprecation.yml
data/deprecations/14-6-runner-api-status-renames-not_connected.yml
data/deprecations/14-7-deprecate-artifacts-keyword.yml
data/deprecations/14-7-deprecate-static-site-editor.yml
data/deprecations/15-0-deprecate-monitor-tracing.yml
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger- Resolved by Evan Read
added 1 commit
- d54808df - Update MR template and edit deprecation files for new standard
- Resolved by Evan Read
@sselhorn @fseifoddini could you review?
I wonder if we still need the prohibition of backticks in headings, given we don't try and render anything in the RP for deprecations anymore: https://about.gitlab.com/releases/2021/12/22/gitlab-14-6-released/#release-deprecations. We do have them in regular docs. For example: https://docs.gitlab.com/ee/ci/yaml/#artifacts. Backticks are invisible on the ToC, but single quotes aren't.
Here's a preview:
requested review from @fseifoddini and @sselhorn
mentioned in issue gitlab-com/www-gitlab-com#12907 (closed)
removed review request for @sselhorn
requested review from @brhea
@fseifoddini
, 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:
added Product Operations prodops:release labels
added 171 commits
-
d54808df...0245456e - 170 commits from branch
master
- 753afcec - Update MR template and edit deprecation files for new standard
-
d54808df...0245456e - 170 commits from branch
added 3 commits
-
753afcec...24c21914 - 2 commits from branch
master
- 4c3b4619 - Update MR template and edit deprecation files for new standard
-
753afcec...24c21914 - 2 commits from branch
added 1 commit
- c28d498d - Update MR template and edit deprecation files for new standard
requested review from @sselhorn
enabled an automatic merge when the pipeline for cdc137a4 succeeds
Thanks so much @eread Definitely an improvement.
mentioned in commit 35b62ef4
added workflowstaging-canary label
added workflowstaging label and removed workflowstaging-canary label
added workflowcanary label and removed workflowstaging label
added workflowproduction label and removed workflowcanary label
mentioned in merge request !80761 (merged)
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label
mentioned in merge request !88076 (merged)