Add a doc/update.md index file. Update headers in main README.md.

README.md

@@ -62,62 +62,64 @@ You can login as an admin user with username `root` and password `5iveL!fe`.
 ### Common installation problems
-See [doc/common_installation_problems.md](doc/common_installation_problems.md).
-#### Apt error 'The requested URL returned error: 403'
+This section has been moved to the separate document [doc/common_installation_problems.md](doc/common_installation_problems.md).
+Section below remains for historical reasons(mainly to not break existing links). Each section contains the link to the new location.
+
+##### Apt error 'The requested URL returned error: 403'
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#apt-error-the-requested-url-returned-error-403).
-#### GitLab is unreachable in my browser
+##### GitLab is unreachable in my browser
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#gitlab-is-unreachable-in-my-browser).
-#### GitLab CI shows GitLab login page
+##### GitLab CI shows GitLab login page
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#gitlab-ci-shows-gitlab-login-page).
-#### Emails are not being delivered
+##### Emails are not being delivered
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#emails-are-not-being-delivered).
-#### Reconfigure freezes at `ruby_block[supervise_redis_sleep] action run`
+##### Reconfigure freezes at `ruby_block[supervise_redis_sleep] action run`
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#reconfigure-freezes-at-ruby_blocksupervise_redis_sleep-action-run).
-#### TCP ports for GitLab services are already taken
+##### TCP ports for GitLab services are already taken
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#tcp-ports-for-gitlab-services-are-already-taken).
-#### Git SSH access stops working on SELinux-enabled systems
+##### Git SSH access stops working on SELinux-enabled systems
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#git-ssh-access-stops-working-on-selinux-enabled-systems
 ).
-#### Postgres error 'FATAL:  could not create shared memory segment: Cannot allocate memory'
+##### Postgres error 'FATAL:  could not create shared memory segment: Cannot allocate memory'
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#postgres-error-fatal-could-not-create-shared-memory-segment-cannot-allocate-memory).
-#### Reconfigure complains about the GLIBC version
+##### Reconfigure complains about the GLIBC version
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#reconfigure-complains-about-the-glibc-version).
-#### Reconfigure fails to create the git user
+##### Reconfigure fails to create the git user
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#reconfigure-fails-to-create-the-git-user).
-#### Failed to modify kernel parameters with sysctl
+##### Failed to modify kernel parameters with sysctl
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#failed-to-modify-kernel-parameters-with-sysctl).
-#### I am unable to install omnibus-gitlab without root access
+##### I am unable to install omnibus-gitlab without root access
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#i-am-unable-to-install-omnibus-gitlab-without-root-access).
-#### gitlab-rake assets:precompile fails with 'Permission denied'
+##### gitlab-rake assets:precompile fails with 'Permission denied'
 See [doc/common_installation_problems.md](doc/common_installation_problems.md#gitlab-rake-assetsprecompile-fails-with-permission-denied).
-#### 'Short read or OOM loading DB' error
+##### 'Short read or OOM loading DB' error
 See [doc/common_installation_problems.md](doc/common_installation_problems.mdr#short-read-or-oom-loading-db-error).

doc/README.md

+# Omnibus GitLab documentation
+
+- [Getting started]()
+
+## Installation
+
+- [Package downloads page](https://about.gitlab.com/downloads/)
+- [GitLab CI](gitlab-ci/README.md) Set up the GitLab CI coordinator that ships with Omnibus GitLab package.
+
+## Updating
+
+- [Note about updating from GitLab 6.6 and higher to 7.10 or newer](update.md#updating-from-gitlab-66-and-higher-to-710-or-newer)
+- [Updating to the latest version](update.md#updating-from-gitlab-66-and-higher-to-the-latest-version)
+- [Updating from GitLab 6.6.0.pre1 to 6.6.4](update.md#updating-from-gitlab-660pre1-to-664)
+- [Downgrading to an earlier version](update.md#reverting-to-gitlab-66x-or-later)
+- [Upgrading from a non-Omnibus installation to an Omnibus installation using a backup](update.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-in-place)
+- [Upgrading from non-Omnibus PostgreSQL to an Omnibus installation in-place](update.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-in-place)
+- [Upgrading from non-Omnibus MySQL to an Omnibus installation (version 6.8+)](update.md#upgrading-from-non-omnibus-mysql-to-an-omnibus-installation-version-68)
+
+## Configuring
+
+- [Configuration options](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template)
+- [SMTP](settings/smtp.md)
+- [NGINX](settings/nginx.md)
+- [LDAP](settings/ldap.md)
+- [Unicorn](settings/unicorn.md)
+- [Environment variables](settings/environment-variables.md).
+- [gitlab.yml](settings/gitlab.yml.md)
+- [Redis](settings/redis.md)
+
+## Troubleshooting
+
+
+## Omnibus GitLab developer documentation
+
+- [Development Setup](development.md)
+- [Release process](release.md)
+- [Building your own package](build.md)

doc/update.md

@@ -121,6 +121,21 @@ Done!
 ## Reverting to GitLab 6.6.x or later
+This section contains general information on how to revert to an earlier version of a package.
+
+*NOTE* This guide assumes that you have a backup archive created under the version you are reverting to.
+
+These steps consist of:
+
+* Download the package of a target version.(example below uses GitLab 6.x.x)
+* Stop GitLab
+* Install the old package
+* Reconfigure GitLab
+* Restoring the backup
+* Starting GitLab
+
+See example below:
+
 First download a GitLab 6.x.x [CE](https://www.gitlab.com/downloads/archives/) or
 [EE (subscribers only)](https://gitlab.com/subscribers/gitlab-ee/blob/master/doc/install/packages.md)
 package.