Add description metadata for six files
What does this MR do?
Adds description
metadata for these six files in various devopscreate groups:
doc/api/repositories.md
doc/topics/git/lfs/index.md
doc/topics/git/numerous_undo_possibilities_in_git/index.md
doc/user/project/merge_requests/reviews/index.md
doc/user/project/repository/branches/default.md
doc/user/project/repository/tags/index.md
When I next start this work, I should start on line 27 of the spreadsheet.
Related issues
Related to Tracking docs metadata updates for Create (#442469 - 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 tier badge 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.
Merge request reports
Activity
changed milestone to %16.10
assigned to @aqualls
- Resolved by Lysanne Pinto
I'll route this review to @lyspin. Not urgent - just my warmup for the day.
requested review from @lyspin
- Resolved by Amy Qualls
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/api/repositories.md
(Link to current live version) -
doc/topics/git/lfs/index.md
(Link to current live version) -
doc/topics/git/numerous_undo_possibilities_in_git/index.md
(Link to current live version) -
doc/user/project/merge_requests/reviews/index.md
(Link to current live version) -
doc/user/project/repository/branches/default.md
(Link to current live version) -
doc/user/project/repository/tags/index.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 docs-only label
enabled an automatic merge when the pipeline for 5b219f1d succeeds
mentioned in commit a5abbf35
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 releasedpublished label