diff options
| author | Yorick Peterse <yorickpeterse@gmail.com> | 2019-02-08 16:24:31 +0300 |
|---|---|---|
| committer | Yorick Peterse <yorickpeterse@gmail.com> | 2019-02-11 17:29:21 +0300 |
| commit | 4d101979150e16c0cc8ac5e0380e9ef407542741 (patch) | |
| tree | cd5c8959cc42d687631095b7cbf27934dea9d1df /doc/development | |
| parent | ef875bd7aa24fd2c68027b8d6c837f33642a606e (diff) | |
Refactor the upgrading from source docs
Instead of requiring one separate document for every version (which is
created by release managers), we now use a single document for both
Community Edition and Enterprise Edition. This allows developers to add
guidelines right away, instead of release managers having to determine
what to add.
Version specific upgrading instructions are placed in a separate
section. This prevents instructions from lingering around for many
versions should a developer forget to remove them. This also ensures
that all instructions are kept in a single place, instead of being
spread across different documents.
A minor downside is that CE and EE guidelines now live in the same
document, which could cause merge conflicts. Since we are working
towards a single codebase, this should only be an issue until we merge
the codebases together; something we expect to do in the coming months.
This commit also removes all old upgrading instructions, but these can
still be accessed using Git branch specific URLs (included in the
updating README).
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/contributing/merge_request_workflow.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index 19b6181c9a2..4e766f37871 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -89,6 +89,11 @@ request is as follows: 1. If your merge request introduces changes that require additional steps when installing GitLab from source, add them to `doc/install/installation.md` in the same merge request. +1. If your merge request introduces changes that require additional steps when + upgrading GitLab from source, add them to + `doc/update/upgrading_from_source.md` in the same merge request. If these + instructions are specific to a version, add them to the "Version specific + upgrading instructions" section. Please keep the change in a single MR **as small as possible**. If you want to contribute a large feature think very hard what the minimum viable change is. |