summaryrefslogtreecommitdiff
path: root/doc/update/README.md
diff options
context:
space:
mode:
authorYorick Peterse <yorickpeterse@gmail.com>2019-02-08 14:24:31 +0100
committerYorick Peterse <yorickpeterse@gmail.com>2019-02-11 15:29:21 +0100
commit4d101979150e16c0cc8ac5e0380e9ef407542741 (patch)
treecd5c8959cc42d687631095b7cbf27934dea9d1df /doc/update/README.md
parentef875bd7aa24fd2c68027b8d6c837f33642a606e (diff)
downloadgitlab-ce-4d101979150e16c0cc8ac5e0380e9ef407542741.tar.gz
Refactor the upgrading from source docsdocs/refactor-update-guides
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/update/README.md')
-rw-r--r--doc/update/README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/update/README.md b/doc/update/README.md
index d4fc0cc91bf..a67b63b0ad5 100644
--- a/doc/update/README.md
+++ b/doc/update/README.md
@@ -18,14 +18,20 @@ Based on your installation, choose a section below that fits your needs.
## Installation from source
-- [Upgrading Community Edition from source][source-ce] - The individual
- upgrade guides are for those who have installed GitLab CE from source.
-- [Upgrading Enterprise Edition from source][source-ee] - The individual
- upgrade guides are for those who have installed GitLab EE from source.
+- [Upgrading Community Edition and Enterprise Edition from
+ source](upgrading_from_source.md) - The guidelines for upgrading Community
+ Edition and Enterprise Edition from source.
- [Patch versions](patch_versions.md) guide includes the steps needed for a
patch version, eg. 6.2.0 to 6.2.1, and apply to both Community and Enterprise
Editions.
+In the past we used separate documents for the upgrading instructions, but we
+have since switched to using a single document. The old upgrading guidelines
+can still be found in the Git repository:
+
+- [Old upgrading guidelines for Community Edition][old-ce-upgrade-docs]
+- [Old upgrading guidelines for Enterprise Edition][old-ee-upgrade-docs]
+
## Installation using Docker
GitLab provides official Docker images for both Community and Enterprise
@@ -138,8 +144,8 @@ possible.
upgrading a PostgreSQL database with minimal downtime.
[omnidocker]: http://docs.gitlab.com/omnibus/docker/README.html
-[source-ee]: https://gitlab.com/gitlab-org/gitlab-ee/tree/master/doc/update
-[source-ce]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/update
+[old-ee-upgrade-docs]: https://gitlab.com/gitlab-org/gitlab-ee/tree/11-8-stable-ee/doc/update
+[old-ce-upgrade-docs]: https://gitlab.com/gitlab-org/gitlab-ce/tree/11-8-stable/doc/update
[ee-ce]: ../downgrade_ee_to_ce/README.md
[ce]: https://about.gitlab.com/features/#community
[ee]: https://about.gitlab.com/features/#enterprise