ref(quickstart): use markdown-include to de-duplicate quickstart info

deis · Jan 11, 2017 · 3e65eba · 3e65eba
1 parent 954f425
commit 3e65eba
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 202 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -109,6 +109,8 @@ theme_dir: themes/deis
 docs_dir: src
 markdown_extensions:
   - markdown_checklist.extension
+  - markdown_include.include:
+      base_path: src/_includes
   - admonition
   - codehilite
   - toc:

diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
 mkdocs==0.15.3
 markdown-checklist==0.4.1
+markdown-include==0.5.1
diff --git a/src/_includes/install-workflow.md b/src/_includes/install-workflow.md
@@ -0,0 +1,67 @@
+## Check Your Setup
+
+First check that the `helm` command is available and the version is v2.1.3 or newer.
+
+```
+$ helm version
+Client: &version.Version{SemVer:"v2.1.3", GitCommit:"5cbc48fb305ca4bf68c26eb8d2a7eb363227e973", GitTreeState:"clean"}
+Server: &version.Version{SemVer:"v2.1.3", GitCommit:"5cbc48fb305ca4bf68c26eb8d2a7eb363227e973", GitTreeState:"clean"}
+```
+
+Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
+
+## Add the Deis Chart Repository
+
+The Deis Chart Repository contains everything needed to install Deis Workflow onto a Kubernetes cluster, with a single `helm install deis/workflow --namespace deis` command.
+
+Add this repository to Helm:
+
+```
+$ helm repo add deis https://charts.deis.com/workflow
+```
+
+## Install Deis Workflow
+
+Now that Helm is installed and the repository has been added, install Workflow by running:
+
+```
+$ helm install deis/workflow --namespace deis
+```
+
+Helm will install a variety of Kubernetes resources in the `deis` namespace.
+Wait for the pods that Helm launched to be ready. Monitor their status by running:
+
+```
+$ kubectl --namespace=deis get pods
+```
+
+If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
+
+```
+$ kubectl --namespace=deis get pods -w
+```
+
+Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
+installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
+automatically restart it.
+
+Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
+
+```
+$ kubectl --namespace=deis get pods
+NAME                          READY     STATUS    RESTARTS   AGE
+deis-builder-hy3xv            1/1       Running   5          5m
+deis-controller-g3cu8         1/1       Running   5          5m
+deis-database-rad1o           1/1       Running   0          5m
+deis-logger-fluentd-1v8uk     1/1       Running   0          5m
+deis-logger-fluentd-esm60     1/1       Running   0          5m
+deis-logger-sm8b3             1/1       Running   0          5m
+deis-minio-4ww3t              1/1       Running   0          5m
+deis-registry-asozo           1/1       Running   1          5m
+deis-router-k1ond             1/1       Running   0          5m
+deis-workflow-manager-68nu6   1/1       Running   0          5m
+```
+
+Once all of the pods are in the `READY` state, Deis Workflow is up and running!
+
+Next, [configure dns](dns.md) so you can register your first user and deploy an application.
diff --git a/src/quickstart/provider/aws/install-aws.md b/src/quickstart/provider/aws/install-aws.md
@@ -1,71 +1,6 @@
 # Installing Deis Workflow on Amazon Web Services
 
-## Check Your Setup
-
-First check that the `helm` command is available and the version is v2.1.0 or newer.
-
-```
-$ helm version
-Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
-Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
-```
-
-Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
-
-## Add the Deis Chart Repository
-
-The Deis Chart Repository contains everything you need to install Workflow onto your Kubernetes
-cluster, with a single `helm install deis/workflow --namespace deis` command.
-
-Run the following command to add this repository to Helm:
-
-```
-$ helm repo add deis https://charts.deis.com/workflow
-```
-
-## Install Deis Workflow
-
-Now that Helm is installed and the repository has been added, install Workflow by running:
-
-```
-$ helm install deis/workflow --namespace deis
-```
-
-Helm will install a variety of Kubernetes resources in the `deis` namespace.
-Wait for the pods that Helm launched to be ready. Monitor their status by running:
-
-```
-$ kubectl --namespace=deis get pods
-```
-
-If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
-
-```
-$ kubectl --namespace=deis get pods -w
-```
-
-Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
-installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
-automatically restart it.
-
-Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
-
-```
-$ kubectl --namespace=deis get pods
-NAME                          READY     STATUS    RESTARTS   AGE
-deis-builder-hy3xv            1/1       Running   5          5m
-deis-controller-g3cu8         1/1       Running   5          5m
-deis-database-rad1o           1/1       Running   0          5m
-deis-logger-fluentd-1v8uk     1/1       Running   0          5m
-deis-logger-fluentd-esm60     1/1       Running   0          5m
-deis-logger-sm8b3             1/1       Running   0          5m
-deis-minio-4ww3t              1/1       Running   0          5m
-deis-registry-asozo           1/1       Running   1          5m
-deis-router-k1ond             1/1       Running   0          5m
-deis-workflow-manager-68nu6   1/1       Running   0          5m
-```
-
-Once all of the pods are in the `READY` state, Deis Workflow is up and running!
+{!install-workflow.md!}
 
 ## Configure your AWS Load Balancer
 
@@ -104,5 +39,3 @@ $ aws elb modify-load-balancer-attributes \
 abce0d48217d311e69a470643b4d9062
 CONNECTIONSETTINGS	1200
 ```
-
-Next, [configure dns](dns.md) so you can register your first user and deploy an application.
diff --git a/src/quickstart/provider/gke/install-gke.md b/src/quickstart/provider/gke/install-gke.md
@@ -1,69 +1,3 @@
 # Install Deis Workflow on Google Compute Engine
 
-## Check Your Setup
-
-First check that the `helm` command is available and the version is v2.1.0 or newer.
-
-```
-$ helm version
-Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
-Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
-```
-
-Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
-
-## Add the Deis Chart Repository
-
-The Deis Chart Repository contains everything needed to install Deis Workflow onto a Kubernetes cluster, with a single `helm install deis/workflow --namespace deis` command.
-
-Add this repository to Helm:
-
-```
-$ helm repo add deis https://charts.deis.com/workflow
-```
-
-## Install Deis Workflow
-
-Now that Helm is installed and the repository has been added, install Workflow by running:
-
-```
-$ helm install deis/workflow --namespace deis
-```
-
-Helm will install a variety of Kubernetes resources in the `deis` namespace.
-Wait for the pods that Helm launched to be ready. Monitor their status by running:
-
-```
-$ kubectl --namespace=deis get pods
-```
-
-If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
-
-```
-$ kubectl --namespace=deis get pods -w
-```
-
-Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
-installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
-automatically restart it.
-
-Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
-
-```
-$ kubectl --namespace=deis get pods
-NAME                          READY     STATUS    RESTARTS   AGE
-deis-builder-hy3xv            1/1       Running   5          5m
-deis-controller-g3cu8         1/1       Running   5          5m
-deis-database-rad1o           1/1       Running   0          5m
-deis-logger-fluentd-1v8uk     1/1       Running   0          5m
-deis-logger-fluentd-esm60     1/1       Running   0          5m
-deis-logger-sm8b3             1/1       Running   0          5m
-deis-minio-4ww3t              1/1       Running   0          5m
-deis-registry-asozo           1/1       Running   1          5m
-deis-router-k1ond             1/1       Running   0          5m
-deis-workflow-manager-68nu6   1/1       Running   0          5m
-```
-
-Once all of the pods are in the `READY` state, Deis Workflow is up and running!
-
-Next, [configure dns](dns.md) so you can register your first user and deploy an application.
+{!install-workflow.md!}
diff --git a/src/quickstart/provider/vagrant/install-vagrant.md b/src/quickstart/provider/vagrant/install-vagrant.md
@@ -1,69 +1,3 @@
 # Install Deis Workflow on Vagrant
 
-## Check Your Setup
-
-First check that the `helm` command is available and the version is v2.1.0 or newer.
-
-```
-$ helm version
-Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
-Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
-```
-
-Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
-
-## Add the Deis Chart Repository
-
-The Deis Chart Repository contains everything needed to install Deis Workflow onto a Kubernetes cluster, with a single `helm install deis/workflow --namespace deis` command.
-
-Add this repository to Helm:
-
-```
-$ helm repo add deis https://charts.deis.com/workflow
-```
-
-## Install Deis Workflow
-
-Now that Helm is installed and the repository has been added, install Workflow by running:
-
-```
-$ helm install deis/workflow --namespace deis
-```
-
-Helm will install a variety of Kubernetes resources in the `deis` namespace.
-Wait for the pods that Helm launched to be ready. Monitor their status by running:
-
-```
-$ kubectl --namespace=deis get pods
-```
-
-If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
-
-```
-$ kubectl --namespace=deis get pods -w
-```
-
-Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
-installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
-automatically restart it.
-
-Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
-
-```
-$ kubectl --namespace=deis get pods
-NAME                          READY     STATUS    RESTARTS   AGE
-deis-builder-hy3xv            1/1       Running   5          5m
-deis-controller-g3cu8         1/1       Running   5          5m
-deis-database-rad1o           1/1       Running   0          5m
-deis-logger-fluentd-1v8uk     1/1       Running   0          5m
-deis-logger-fluentd-esm60     1/1       Running   0          5m
-deis-logger-sm8b3             1/1       Running   0          5m
-deis-minio-4ww3t              1/1       Running   0          5m
-deis-registry-asozo           1/1       Running   1          5m
-deis-router-k1ond             1/1       Running   0          5m
-deis-workflow-manager-68nu6   1/1       Running   0          5m
-```
-
-Once all of the pods are in the `READY` state, Deis Workflow is up and running!
-
-Next, [configure dns](dns.md) so you can register your first user and deploy an application.
+{!install-workflow.md!}