Revise cherry-pick page for CTRT
What does this MR do?
I had some time, and I have #293646 (closed) in my backlog requesting more plain language to be used in Git-related pages. I arbitrarily cherry-picked: https://docs.gitlab.com/ee/topics/git/cherry_picking.html
Notes for the reviewer:
- We used
cherry pick
on this page, but Git's documentation usescherry-pick
. I updated the instances here, and elsewhere, in the documentation to use the hyphenated version. - I gardened in more information, especially around the concept of a SHA, because we didn't really tell a user what a SHA was or how to find it.
- Page is missing from the left nav. I've spun up gitlab-docs!2092 (merged) for that.
Related issues
Related to #293646 (closed)
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:
~"feature"
~"frontend"
~"backend"
~"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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.
Edited by Amy Qualls