Merge branch '26014-fix-update-doc' into 'master'

Re-order update steps in the 8.14 -> 8.15 upgrade guide

Closes #26014

See merge request !8287

4 files changed, 87 insertions, 49 deletions

diff --git a/changelogs/unreleased/26014-fix-update-doc.yml b/changelogs/unreleased/26014-fix-update-doc.yml
new file mode 100644
index 00000000000..419c032cb0f
--- /dev/null
+++ b/changelogs/unreleased/26014-fix-update-doc.yml
@@ -0,0 +1,4 @@
+---
+title: Re-order update steps in the 8.14 -> 8.15 upgrade guide
+merge_request:
+author:
diff --git a/doc/install/installation.md b/doc/install/installation.md
index 2740b2982b9..d2ff2b47cd8 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -400,16 +400,10 @@ GitLab-Workhorse uses [GNU Make](https://www.gnu.org/software/make/). The
 following command-line will install GitLab-Workhorse in `/home/git/gitlab-workhorse`
 which is the recommended location.
 
-    cd /home/git/gitlab
-
     sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
 
 ### Initialize Database and Activate Advanced Features
 
-    # Go to GitLab installation folder
-
-    cd /home/git/gitlab
-
     sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production
 
     # Type 'yes' to create the database tables.
diff --git a/doc/update/8.14-to-8.15.md b/doc/update/8.14-to-8.15.md
index 8d4bfd913bd..b1e3b116548 100644
--- a/doc/update/8.14-to-8.15.md
+++ b/doc/update/8.14-to-8.15.md
@@ -11,12 +11,15 @@ guide links by version.
 
 ### 1. Stop server
 
-    sudo service gitlab stop
+```bash
+sudo service gitlab stop
+```
 
 ### 2. Backup
 
 ```bash
 cd /home/git/gitlab
+
 sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
 ```
 
@@ -49,6 +52,8 @@ sudo gem install bundler --no-ri --no-rdoc
 ### 4. Get latest code
 
 ```bash
+cd /home/git/gitlab
+
 sudo -u git -H git fetch --all
 sudo -u git -H git checkout -- db/schema.rb # local changes will be restored automatically
 ```
@@ -56,6 +61,8 @@ sudo -u git -H git checkout -- db/schema.rb # local changes will be restored aut
 For GitLab Community Edition:
 
 ```bash
+cd /home/git/gitlab
+
 sudo -u git -H git checkout 8-15-stable
 ```
 
@@ -64,28 +71,12 @@ OR
 For GitLab Enterprise Edition:
 
 ```bash
-sudo -u git -H git checkout 8-15-stable-ee
-```
-
-### 5. Update gitlab-shell
-
-```bash
-cd /home/git/gitlab-shell
-sudo -u git -H git fetch --all --tags
-sudo -u git -H git checkout v4.1.1
-```
-
-### 6. Update gitlab-workhorse
-
-Install and compile gitlab-workhorse. This requires
-[Go 1.5](https://golang.org/dl) which should already be on your system from
-GitLab 8.1.
+cd /home/git/gitlab
 
-```bash
-sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
+sudo -u git -H git checkout 8-15-stable-ee
 ```
 
-### 7. Install libs, migrations, etc.
+### 5. Install libs, migrations, etc.
 
 ```bash
 cd /home/git/gitlab
@@ -106,6 +97,27 @@ sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production
 sudo -u git -H bundle exec rake assets:clean assets:precompile cache:clear RAILS_ENV=production
 ```
 
+### 6. Update gitlab-workhorse
+
+Install and compile gitlab-workhorse. This requires
+[Go 1.5](https://golang.org/dl) which should already be on your system from
+GitLab 8.1.
+
+```bash
+cd /home/git/gitlab
+
+sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
+```
+
+### 7. Update gitlab-shell
+
+```bash
+cd /home/git/gitlab-shell
+
+sudo -u git -H git fetch --all --tags
+sudo -u git -H git checkout v4.1.1
+```
+
 ### 8. Update configuration files
 
 #### New configuration options for `gitlab.yml`
@@ -113,6 +125,8 @@ sudo -u git -H bundle exec rake assets:clean assets:precompile cache:clear RAILS
 There are new configuration options available for [`gitlab.yml`](config/gitlab.yml.example). View them with the command below and apply them manually to your current `gitlab.yml`:
 
 ```sh
+cd /home/git/gitlab
+
 git diff origin/8-14-stable:config/gitlab.yml.example origin/8-15-stable:config/gitlab.yml.example
 ```
 
@@ -122,6 +136,8 @@ Configure Git to generate packfile bitmaps (introduced in Git 2.0) on
 the GitLab server during `git gc`.
 
 ```sh
+cd /home/git/gitlab
+
 sudo -u git -H git config --global repack.writeBitmaps true
 ```
 
@@ -130,6 +146,8 @@ sudo -u git -H git config --global repack.writeBitmaps true
 Ensure you're still up-to-date with the latest NGINX configuration changes:
 
 ```sh
+cd /home/git/gitlab
+
 # For HTTPS configurations
 git diff origin/8-14-stable:lib/support/nginx/gitlab-ssl origin/8-15-stable:lib/support/nginx/gitlab-ssl
 
@@ -162,26 +180,42 @@ See [smtp_settings.rb.sample] as an example.
 
 Ensure you're still up-to-date with the latest init script changes:
 
-    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
+```bash
+cd /home/git/gitlab
+
+sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
+```
 
 For Ubuntu 16.04.1 LTS:
 
-    sudo systemctl daemon-reload
+```bash
+sudo systemctl daemon-reload
+```
 
 ### 9. Start application
 
-    sudo service gitlab start
-    sudo service nginx restart
+```bash
+sudo service gitlab start
+sudo service nginx restart
+```
 
 ### 10. Check application status
 
 Check if GitLab and its environment are configured correctly:
 
-    sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
+```bash
+cd /home/git/gitlab
+
+sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
+```
 
 To make sure you didn't miss anything run a more thorough check:
 
-    sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
+```bash
+cd /home/git/gitlab
+
+sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
+```
 
 If all items are green, then congratulations, the upgrade is complete!
 
@@ -196,6 +230,7 @@ database migration (the backup is already migrated to the previous version).
 
 ```bash
 cd /home/git/gitlab
+
 sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production
 ```
 
diff --git a/doc/update/patch_versions.md b/doc/update/patch_versions.md
index 685972cfb41..54d523b59fd 100644
--- a/doc/update/patch_versions.md
+++ b/doc/update/patch_versions.md
@@ -14,6 +14,7 @@ user on the database version)
 
 ```bash
 cd /home/git/gitlab
+
 sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
 ```
 
@@ -32,28 +33,13 @@ current version with `cat VERSION`).
 
 ```bash
 cd /home/git/gitlab
+
 sudo -u git -H git fetch --all
 sudo -u git -H git checkout -- Gemfile.lock db/schema.rb
 sudo -u git -H git checkout LATEST_TAG -b LATEST_TAG
 ```
 
-### 3. Update gitlab-shell to the corresponding version
-
-```bash
-cd /home/git/gitlab-shell
-sudo -u git -H git fetch
-sudo -u git -H git checkout v`cat /home/git/gitlab/GITLAB_SHELL_VERSION` -b v`cat /home/git/gitlab/GITLAB_SHELL_VERSION`
-```
-
-### 4. Update gitlab-workhorse to the corresponding version
-
-```bash
-cd /home/git/gitlab
-
-sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
-```
-
-### 5. Install libs, migrations, etc.
+### 3. Install libs, migrations, etc.
 
 ```bash
 cd /home/git/gitlab
@@ -74,6 +60,23 @@ sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production
 sudo -u git -H bundle exec rake assets:clean assets:precompile cache:clear RAILS_ENV=production
 ```
 
+### 4. Update gitlab-workhorse to the corresponding version
+
+```bash
+cd /home/git/gitlab
+
+sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
+```
+
+### 5. Update gitlab-shell to the corresponding version
+
+```bash
+cd /home/git/gitlab-shell
+
+sudo -u git -H git fetch --all --tags
+sudo -u git -H git checkout v`cat /home/git/gitlab/GITLAB_SHELL_VERSION` -b v`cat /home/git/gitlab/GITLAB_SHELL_VERSION`
+```
+
 ### 6. Start application
 
 ```bash
@@ -86,6 +89,8 @@ sudo service nginx restart
 Check if GitLab and its environment are configured correctly:
 
 ```bash
+cd /home/git/gitlab
+
 sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
 ```