Combine cherry-pick pages and redirect one
What does this MR do?
As part of #22236 (closed), recently completed by groupcode review, I needed to review our cherry-picking instructions to ensure they were in sync with the change in the feature. I've known for a while that we had two cherry-pick pages: one in the user docs and one in the Git topic docs. While looking, I discovered these things:
- The user docs page (https://docs.gitlab.com/ee/user/project/merge_requests/cherry_pick_changes.html) is in the top 15% of viewed pages.
- The Git topic page was not.
- The Git topic page also had only one real subheading left, and it was about cherry-picking from the CLI.
- That one topic could be easily rolled into the other page.
From a SEO angle, I think it makes sense to keep the page in the doc/user
hierarchy, redirect the smaller / less-used doc/topics/git
page to it, and reduce the number of pages to maintain.
Related issues
- Closes Docs: revert/cherry-pick squashed MRs with FF s... (#439097 - closed)
- Related to Enable cherry-picking for fast-forward commits,... (#22236 - 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.