FY24Q2 Add examples of required upgrade stop to the product documentation
Summary
To help GitLab contributors understand what is a change that will cause an upgrade stop, the documentation can be enhanced by listing all known types of breaking changes for contributors' reference, so that unintended stops can be prevented.
This list of breaking changes can be added to the Upgrade
section of product document https://docs.gitlab.com/ee/update/.
Acceptance criteria
- List known change types with examples that could cause an upgrade stop in https://docs.gitlab.com/ee/development/development_processes.html as a new page for both database and code/configuration, the database ones can be referred to existing page https://docs.gitlab.com/ee/development/database/required_stops.html
- Work with groupdatabase for any cross-reference and formatting consistent as they have a similar objective
Reference
- OKR - https://gitlab.com/gitlab-com/gitlab-OKRs/-/work_items/1884?iid_path=true
- Discussion - https://gitlab.com/gitlab-com/gitlab-OKRs/-/work_items/1794?iid_path=true#note_1357631405
/cc @alexives
Edited by Peter Lu