Merge branch 'docs/autodevops-fixes' into 'master'

Fix Auto DevOps quick start guide

Closes #37768

See merge request !14230

1 files changed, 61 insertions, 19 deletions

diff --git a/doc/topics/autodevops/quick_start_guide.md b/doc/topics/autodevops/quick_start_guide.md
index f23c9d794b4..564dd3222ac 100644
--- a/doc/topics/autodevops/quick_start_guide.md
+++ b/doc/topics/autodevops/quick_start_guide.md
@@ -18,45 +18,66 @@ example for this guide. It contains two files:
 ## Fork sample project on GitLab.com
 
 Let’s start by forking our sample application. Go to [the project
-page](https://gitlab.com/gitlab-examples/minimal-ruby-app) and press the `Fork`
-button. Soon you should have a project under your namespace with the necessary
-files.
+page](https://gitlab.com/auto-devops-examples/minimal-ruby-app) and press the
+**Fork** button. Soon you should have a project under your namespace with the
+necessary files.
 
 ## Setup your own cluster on Google Container Engine
 
-If you do not already have a Google Cloud account, create one at https://console.cloud.google.com.
+If you do not already have a Google Cloud account, create one at
+https://console.cloud.google.com.
 
-Visit the [`Container Engine`](https://console.cloud.google.com/kubernetes/list) tab and create a new cluster. You can change the name and leave the rest of the default settings. Once you have your cluster running, you need to connect to the cluster by following the Google interface.
+Visit the [**Container Engine**](https://console.cloud.google.com/kubernetes/list)
+tab and create a new cluster. You can change the name and leave the rest of the
+default settings. Once you have your cluster running, you need to connect to the
+cluster by following the Google interface.
 
 ## Connect to Kubernetes cluster
 
 You need to have the Google Cloud SDK installed. e.g.
-On OSX, install [homebrew](https://brew.sh):
+On macOS, install [homebrew](https://brew.sh):
 
 1. Install Brew Caskroom: `brew install caskroom/cask/brew-cask`
 2. Install Google Cloud SDK: `brew cask install google-cloud-sdk`
-3. Add `kubectl`: `gcloud components install kubectl`
+3. Add `kubectl` with: `gcloud components install kubectl`
 4. Log in: `gcloud auth login`
 
-Now go back to the Google interface, find your cluster, and follow the instructions under `Connect to the cluster` and open the Kubernetes Dashboard. It will look something like `gcloud container clusters get-credentials ruby-autodeploy \ --zone europe-west2-c --project api-project-XXXXXXX` and then `kubectl proxy`.
+Now go back to the Google interface, find your cluster, follow the instructions
+under "Connect to the cluster" and open the Kubernetes Dashboard. It will look
+something like:
+
+```sh
+gcloud container clusters get-credentials ruby-autodeploy \ --zone europe-west2-c --project api-project-XXXXXXX
+```
+
+Finally, run `kubectl proxy`.
 
 ![connect to cluster](img/guide_connect_cluster.png)
 
 ## Copy credentials to GitLab.com project
 
-Once you have the Kubernetes Dashboard interface running, you should visit `Secrets` under the  `Config` section. There you should find the settings we need for GitLab integration: ca.crt and token.
+Once you have the Kubernetes Dashboard interface running, you should visit
+**Secrets** under the  "Config" section. There, you should find the settings we
+need for GitLab integration: `ca.crt` and token.
 
 ![connect to cluster](img/guide_secret.png)
 
-You need to copy-paste the ca.crt and token into your project on GitLab.com in the Kubernetes integration page under project **Settings > Integrations > Project services > Kubernetes**. Don't actually copy the namespace though. Each project should have a unique namespace, and by leaving it blank, GitLab will create one for you.
+You need to copy-paste the `ca.crt` and token into your project on GitLab.com in
+the Kubernetes integration page under project
+**Settings > Integrations > Project services > Kubernetes**. Don't actually copy
+the namespace though. Each project should have a unique namespace, and by leaving
+it blank, GitLab will create one for you.
 
 ![connect to cluster](img/guide_integration.png)
 
-For API URL, you should use the `Endpoint` IP from your cluster page on Google Cloud Platform.
+For the API URL, you should use the "Endpoint" IP from your cluster page on
+Google Cloud Platform.
 
 ## Expose application to the world
 
-In order to be able to visit your application, you need to install an NGINX ingress controller and point your domain name to its external IP address.
+In order to be able to visit your application, you need to install an NGINX
+ingress controller and point your domain name to its external IP address. Let's
+see how that's done.
 
 ### Set up Ingress controller
 
@@ -68,28 +89,49 @@ helm init
 helm install --name ruby-app stable/nginx-ingress
 ```
 
-This should create several services including `ruby-app-nginx-ingress-controller`. You can list your services by running `kubectl get svc` to confirm that.
+This should create several services including `ruby-app-nginx-ingress-controller`.
+You can list your services by running `kubectl get svc` to confirm that.
 
 ### Point DNS at Cluster IP
 
-Find out the external IP address of the `ruby-app-nginx-ingress-controller` by running:
+Find out the external IP address of the `ruby-app-nginx-ingress-controller` by
+running:
 
 ```sh
 kubectl get svc ruby-app-nginx-ingress-controller -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
 ```
 
-Use this IP address to configure your DNS. This part heavily depends on your preferences and domain provider. But in case you are not sure, just create an A record with a wildcard host like `*.<your-domain>`.
+Use this IP address to configure your DNS. This part heavily depends on your
+preferences and domain provider. But in case you are not sure, just create an
+A record with a wildcard host like `*.<your-domain>`.
 
-Use `nslookup minimal-ruby-app-staging.<yourdomain>` to confirm that domain is assigned to the cluster IP.
+Use `nslookup minimal-ruby-app-staging.<yourdomain>` to confirm that domain is
+assigned to the cluster IP.
 
 ## Set up Auto DevOps
 
-In your GitLab.com project, go to **Settings > CI/CD** and find the Auto DevOps section. Select "Enable Auto DevOps", add in your base domain, and save.
+In your GitLab.com project, go to **Settings > CI/CD** and find the Auto DevOps
+section. Select "Enable Auto DevOps", add in your base domain, and save.
 
 ![auto devops settings](img/auto_devops_settings.png)
 
-Then trigger your first pipeline run. This will create a new pipeline with several jobs: `build`, `test`, `codequality`, and `production`. The `build` job will create a docker image with your new change and push it to the GitLab Container Registry. The `test` job will test your change. The `codequality` job will run static analysis on your change. The `production` job will deploy your change to a production application. Once the deploy job succeeds you should be able to see your application by visiting the Kubernetes dashboard. Select the namespace of your project, which will look like `minimal-ruby-app-23`, but with a unique ID for your project, and your app will be listed as "production" under the Deployment tab.
+Next, a pipeline needs to be triggered. Since the test project doesn't have a
+`.gitlab-ci.yml`, you need to either push a change to the repository or
+manually visit `https://gitlab.com/<username>/minimal-ruby-app/pipelines/run`,
+where `<username>` is your username.
+
+This will create a new pipeline with several jobs: `build`, `test`, `codequality`,
+and `production`. The `build` job will create a Docker image with your new
+change and push it to the Container Registry. The `test` job will test your
+changes, whereas the `codequality` job will run static analysis on your changes.
+Finally, the `production` job will deploy your changes to a production application.
+
+Once the deploy job succeeds you should be able to see your application by
+visiting the Kubernetes dashboard. Select the namespace of your project, which
+will look like `minimal-ruby-app-23`, but with a unique ID for your project,
+and your app will be listed as "production" under the Deployment tab.
 
-Once its ready - just visit http://minimal-ruby-app.example.com to see “Hello, world!”
+Once its ready, just visit `http://minimal-ruby-app.example.com` to see the
+famous "Hello, world!"!
 
 [ce-37115]: https://gitlab.com/gitlab-org/gitlab-ce/issues/37115