Merge pull request #7708 from opf/housekeeping/upgrade-guides

Update references from stable/9 to stable/10

[ci skip]

docs/installation/docker/README.md

@@ -19,7 +19,18 @@ the options that the package-based or manual installation provides.
 The fastest way to get an OpenProject instance up and running is to run the
 following command:
 
-    docker run -it -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:8
+    docker run -it -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:latest
+
+This assumes you want to run the latest stable version. Please see the docker tags listing for the tags we provide:
+https://hub.docker.com/r/openproject/community/tags
+
+In general, we provide the following tags:
+
+ - `latest`: Points to the latest stable version released
+ - `X`: The latest stable version for the given major release. e.g., (8) for 8.x.x release, (9) for 9.x.x -
+        You will never upgrade between major versions automatically with this
+ - `X.Y`: The latest stable version for the given major.minor release. e.g, (8.1) for 8.1.x releases
+ - `X.Y.Z`: The pinned version for one specific release version e.g., 9.0.3
 
 This will take a bit of time the first time you launch it, but after a few
 minutes you should see a success message indicating the default administration
@@ -35,7 +46,7 @@ the logs to your terminal, which helps with debugging if anything goes wrong.
 For normal usage you probably want to start it in the background, which can be
 achieved with the `-d` flag:
 
-    docker run -d -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:8
+    docker run -d -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:latest
 
 ### Recommended usage
 
@@ -56,7 +67,7 @@ those directories mounted:
     docker run -d -p 8080:80 --name openproject -e SECRET_KEY_BASE=secret \
       -v /var/lib/openproject/pgdata:/var/openproject/pgdata \
       -v /var/lib/openproject/static:/var/openproject/assets \
-      openproject/community:8
+      openproject/community:latest
 
 Since we named the container, you can now stop it by running:
 
@@ -152,5 +163,5 @@ Yes, you can do so by passing a command when you launch the container. By defaul
 
 Example:
 
-      docker run -d -e DATABASE_URL=xxx ... openproject/community:8 ./docker/web
-      docker run -d -e DATABASE_URL=xxx ... openproject/community:8 ./docker/worker
+      docker run -d -e DATABASE_URL=xxx ... openproject/community:latest ./docker/web
+      docker run -d -e DATABASE_URL=xxx ... openproject/community:latest ./docker/worker

docs/installation/manual/README.md

@@ -204,7 +204,7 @@ with OpenProject. For more information, see https://github.com/opf/openproject.
 
 ```bash
 [openproject@host] cd ~
-[openproject@host] git clone https://github.com/opf/openproject.git --branch stable/9 --depth 1
+[openproject@host] git clone https://github.com/opf/openproject.git --branch stable/10 --depth 1
 [openproject@host] cd openproject
 # Ensure rubygems is up-to-date for bundler 2
 [openproject@host] gem update --system

docs/installation/packaged/0-preparation.md

@@ -21,10 +21,10 @@ The package will set up:
 * Apache 2 (web server) – this component provides the external interface,
   handles SSL termination (if SSL is used) and distributes/forwards web
 requests to the Unicorn processes.
-* MySQL (database management system) – this component is used to store and
-  retrieve data. We do support PostgreSQL as well, but it is not part of the automatic wizard. To configure this instead, see below.
+* PostgreSQL (database management system) – this component is used to store and
+  retrieve data.
 * Unicorn (application server) – this component hosts the actual application.
   By default, there is two unicorn processes running in parallel on the app
 server machine.
-* Ruby 2.2 (MRI) and necessary libraries to run the OpenProject source code.
+* Ruby 2.6 (MRI) and necessary libraries to run the OpenProject source code.
 

docs/installation/packaged/centos-7/README.md

@@ -6,7 +6,7 @@ All steps are run with `sudo` to execute as the root user.
 
 ```
 sudo wget -O /etc/yum.repos.d/openproject.repo \
-  https://dl.packager.io/srv/opf/openproject/stable/9/installer/el/7.repo
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/el/7.repo
 ```
 
 **2. Install the OpenProject Community Edition package**

docs/installation/packaged/debian-10/README.md

@@ -1,6 +1,6 @@
-### Steps to install OpenProject on Ubuntu 14.04 Trusty
+### Steps to install OpenProject on Debian 10 (Buster)
 
-All steps are prepended with `sudo` to ensure execution as the root user.
+All steps need to be run as `root`.
 
 **1. Import the packager.io repository signing key**
 
@@ -10,17 +10,23 @@ Import the PGP key used to sign our packages. Since we're using the _packager.io
 wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
 ```
 
-**2. Ensure that apt-transport-https is installed**
+**2. Install apt-https suppport**
+
+Since we only provide https package sources, you may need to install `apt-transport-https` as a preliminary step.
+
+```bash
+apt-get install apt-transport-https
+```
 
-Our repository requires apt to have https support. Install this transport method with `sudo apt-get install apt-transport-https` if you did not already.
 
 **3. Add the OpenProject package source**
 
 ```
-sudo wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/9/installer/ubuntu/14.04.repo
+wget -O /etc/apt/sources.list.d/openproject.list \
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/debian/10.repo
 ```
 
+
 **4. Install the OpenProject Community Edition package**
 
 Using the following commands, apt will check the new package source and install the package and all required dependencies.

docs/installation/packaged/debian-9/README.md

@@ -23,7 +23,7 @@ apt-get install apt-transport-https
 
 ```
 wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/9/installer/debian/9.repo
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/debian/9.repo
 ```
 
 

docs/installation/packaged/sles-12/README.md

@@ -6,7 +6,7 @@ All steps need to be run as `root`.
 
 ```
 wget -O /etc/zypp/repos.d/openproject.repo \
-  https://dl.packager.io/srv/opf/openproject/stable/9/installer/sles/12.repo
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/sles/12.repo
 ```
 
 The package source is now registered as `openproject`.

docs/installation/packaged/ubuntu-16.04/README.md

@@ -18,7 +18,7 @@ Our repository requires apt to have https support. Install this transport method
 
 ```
 sudo wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/9/installer/ubuntu/16.04.repo
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/ubuntu/16.04.repo
 ```
 
 

docs/installation/packaged/ubuntu-18.04/README.md

@@ -27,7 +27,7 @@ sudo add-apt-repository universe
 
 ```
 sudo wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/9/installer/ubuntu/18.04.repo
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/ubuntu/18.04.repo
 ```
 
 

docs/installation/system-requirements.md

@@ -17,6 +17,7 @@ provide any official support for them.
 | :------------------------------ | :----------- | :---------- |
 | CentOS/RHEL 7.x                 | centos-7     | systemd     |
 | Debian 9 Stretch                | debian-9     | systemd     |
+| Debian 10 Stretch               | debian-10    | systemd     |
 | Suse Linux Enterprise Server 12 | sles-12      | sysvinit    |
 | Ubuntu 16.04 Xenial Xerus       | ubuntu-16.04 | upstart     |
 | Ubuntu 18.04 Bionic Beaver      | ubuntu-18.04 | systemd     |

docs/operations/upgrading/docker/upgrading.md

@@ -17,12 +17,16 @@ This time, it will use the new image:
 
 # Upgrade Notes
 
+## OpenProject 10.x
+
+### MySQL support dropped
+
+OpenProject 10.0 has dropped MySQL support. For more information regarding motivation behind this and migration steps, please see https://www.openproject.org/deprecating-mysql-support/
+In this post, you will find documentation for a mostly-automated migration script to PostgreSQL to help you get up and running with PostgreSQL.
+
 ## OpenProject 9.x
 
 ### MySQL is being deprecated
 
 OpenProject 9.0 is deprecating MySQL support. You can expect full MySQL support for the course of 9.0 releases, but we
 are likely going to be dropping MySQL completely in one of the following releases.
-
-For more information regarding motivation behind this and migration steps, please see https://www.openproject.org/deprecating-mysql-support/
-In this post, you will find documentation for a mostly-automated migration script to PostgreSQL to help you get up and running with PostgreSQL.

docs/operations/upgrading/manual/upgrading.md

@@ -1,6 +1,6 @@
-# OpenProject 8.x to OpenProject 9.x Debian/Ubuntu Upgrade Guide (Manual installation)
+# OpenProject 9.x to OpenProject 10.x Debian/Ubuntu Upgrade Guide (Manual installation)
 
-OpenProject 9.x is being released at https://github.com/opf/openproject under the branch `stable/9`.
+OpenProject 10.x is being released at https://github.com/opf/openproject under the branch `stable/10`.
 Follow the following steps to perform the upgrade:
 
 First, perform a backup for your current environment
@@ -12,7 +12,7 @@ First, perform a backup for your current environment
 ```
 
 Depending on from what version you're upgrading, you may need to add the correct remote
-Then, check out the stable version of OpenProject 9.x.
+Then, check out the stable version of OpenProject 10.x.
 
 ```bash
 [openproject@debian]# cd /home/openproject/openproject
@@ -25,13 +25,13 @@ If this returns anything, update the remote to the correct URL.
 [openproject@debian]# git remote set-url origin https://github.com/opf/openproject.git
 ```
 
-Then, refresh that origin and checkout the stable/9 branch.
+Then, refresh that origin and checkout the stable/10 branch.
 
 ```bash
-[openproject@debian]# git fetch && git checkout stable/9
+[openproject@debian]# git fetch && git checkout stable/10
 ```
 
-After upgrading the installation files, you need to migrate the installation to OpenProject 9.0 with the following steps:
+After upgrading the installation files, you need to migrate the installation to OpenProject 10.0 with the following steps:
 
 ```bash
 [openproject@debian]# cd /home/openproject/openproject
@@ -42,20 +42,20 @@ After upgrading the installation files, you need to migrate the installation to
 [openproject@debian]# touch tmp/restart.txt
 ```
 
-After performing these steps, the server should be running OpenProject 9.0.x.
+After performing these steps, the server should be running OpenProject 10.0.x.
 
 
 ## Upgrade notes
 
-These following points are some known issues around the update to 9.0.
+These following points are some known issues around the update to 10.0.
 It does not contain the entire list of changes.
 
-To see all changes, [please browse the release notes](https://www.openproject.org/release-notes/openproject-9-0-0/).
+To see all changes, [please browse the release notes](https://www.openproject.org/release-notes/openproject-10-0-0/).
 
-### MySQL is being deprecated
+### MySQL support dropped
 
-OpenProject 9.0. is deprecating MySQL support. You can expect full MySQL support for the course of 9.0 releases, but we
-are likely going to be dropping MySQL completely in one of the following releases.
+OpenProject 10.0 has dropped MySQL support. For more information regarding motivation behind this and migration steps, please see https://www.openproject.org/deprecating-mysql-support/
+In this post, you will find documentation for a mostly-automated migration script to PostgreSQL to help you get up and running with PostgreSQL.
 
 For more information regarding motivation behind this and migration steps, please see https://www.openproject.org/deprecating-mysql-support/
 In this post, you will find documentation for a mostly-automated migration script to PostgreSQL to help you get up and running with PostgreSQL.

docs/operations/upgrading/packaged/upgrading.md

@@ -53,54 +53,56 @@ Since OpenProject 9.0.0 is a major upgrade, you will need to perform some basic
 First, please check that the package repository is correct.
 Compare your local package repository with the one printed on your matching distribution on [our Download and Installation page](https://www.openproject.org/download-and-installation/)
 
-## Upgrade notes for OpenProject 9.0
+## Upgrade notes for OpenProject 10.0
 
-These following points are some known issues around the update to 9.0.
+These following points are some known issues around the update to 10.0.
 
 It does not contain the entire list of changes.
-To see all changes, [please browse the release notes](https://www.openproject.org/release-notes/openproject-9-0-0/).
+To see all changes, [please browse the release notes](https://www.openproject.org/release-notes/openproject-10-0-0/).
 
 ### Package repository moved into opf/openproject
 
 The OpenProject community installation is now using the same repository as the OpenProject development core.
 
 Please update your package source according to [our Download and Installation page](https://www.openproject.org/download-and-installation/).
-You will need to replace `opf/openproject-ce` with `opf/openproject` together with a change from `stable/8` to `stable/9` in order to perform the update.
+You will need to replace `stable/9` to `stable/10` in order to perform the update.
 
-### MySQL is being deprecated
+### MySQL support was dropped
 
-OpenProject 9.0. is deprecating MySQL support. You can expect full MySQL support for the course of 9.0 releases, but we
-are likely going to be dropping MySQL completely in one of the following releases.
+After announcement in the previous major release, OpenProject 10.0 has dropped MySQL support.
 
 For more information regarding motivation behind this and migration steps, please see https://www.openproject.org/deprecating-mysql-support/
 In this post, you will find documentation for a mostly-automated migration script to PostgreSQL to help you get up and running with PostgreSQL.
 
 ## Upgrade steps
 
-If you have currently installed the stable 8.x release of OpenProject by using the `stable/8` package source,
-you will need to adjust that package source.
+If you have currently installed the stable 9.x release of OpenProject by using the `stable/9` package source,
+you will need to adjust that package source to `stable/10`
 
 ### APT-based systems (Debian, Ubuntu)
 
- - Update the reference to `opf/openproject-ce` in `/etc/apt/sources.list.d/openproject.list` to `opf/openproject`.
- - Update the reference to `stable/8` in `/etc/apt/sources.list.d/openproject.list` to `stable/9`.
+ - Update the reference to `stable/9` in `/etc/apt/sources.list.d/openproject.list` to `stable/10`.
  - Perform the Upgrade steps as mentioned above in *Upgrading your OpenProject installation*
 
 ### YUM-based systems (CentOS, RHEL)
 
- - Update the reference to `opf/openproject-ce` in `/etc/yum.repos.d/openproject.repo` to `opf/openproject`.
- - Update the reference to `stable/8` in `/etc/yum.repos.d/openproject.repo` to `stable/9`.
+ - Update the reference to `stable/9` in `/etc/yum.repos.d/openproject.repo` to `stable/10`.
  - Perform the Upgrade steps as mentioned above in *Upgrading your OpenProject installation*
 
 ### SUSE Linux Enterprise Server 12
 
- - Update the reference to `opf/openproject-ce` in `/etc/zypp/repos.d/openproject.repo` to `opf/openproject`.
- - Update the reference to `stable/8` in `/etc/zypp/repos.d/openproject.repo` to `stable/9`.
+ - Update the reference to `stable/9` in `/etc/zypp/repos.d/openproject.repo` to `stable/10`.
  - Perform the Upgrade steps as mentioned above in *Upgrading your OpenProject installation*
 
 
 ## Previous Upgrade notes
 
+### Upgrade notes for OpenProject 8.x. to 9.x
+
+The package source has changed from `openproject-ce` to `openproject`. Please upgrade your repository source entry
+appropriately.
+
+
 ### Upgrade notes for OpenProject 7.0. to 8.x
 
 These following points are some known issues around the update to 8.0. It does not contain the entire list of changes. To see all changes, [please browse the release notes](https://www.openproject.org/release-notes/openproject-8-0/).