Documentation: Create auto-merge page for new feature
Problem to solve
The "merge when pipeline succeeds" feature is expanding and being renamed. We need to write new documentation to support it, because focus of the new feature is different from the previous MWPS feature.
Further details
The docs for the old + new feature are both on https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html. We should consider whether to:
- Rename
merge_when_pipeline_succeeds.md
and continue discussing both features there - Create a new page (
auto_merge.md
?), move the new features to there, mark the MWPS page as deprecated, and gradually repoint everything to the new page. Would probably be better for SEO.
(aside: I originally started writing this list assuming we'd rename, but as I kept writing out the issue's details, I realized creating a new page would save us some significant pain.)
Proposal
Rename and completely revamp https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html to match the name of the feature going forward. The engineering work is being done in &10874.
Who can address the issue
The TW (me!) with PM and engineering help.
Other links/references
It's important to note that I - and the groupcode review team - have known for a long time this feature was coming. An epic exists for the engineering work, as do other issues for the constellation of related items. Try not to be intimidated by this huge pile of references in the epic and the technical-writing
issue:
newer:
- Related to Automatically merge when merge checks pass (&10874) (epic)
- Related to Document new Merge When Checks Pass (#431449 - closed) which was part 1 of the docs MVC
- Related to Docs follow-up: Merge When Checks Pass (#440696 - closed) which contained follow-ups from #431449 (closed)
older:
- Related to Plan for changes from 'auto_merge_labels_mr_wid... (technical-writing#782) where I charted out lots of ancillary work that needs to happen
- Related to Replace merge strategy labels with `Auto-merge`... (#359057 - closed)
- (there are lots of others - check technical-writing#782 and &10874 for a full list)