Merge pull request #241 from garethahealy/master

Fixed dead links in docs

.travis.yml

@@ -3,6 +3,12 @@ language: python
 python:
   - "3.7"
 
+addons:
+  apt:
+    packages:
+      - nodejs
+      - npm
+
 cache:
   directories:
     - $HOME/.cache/pip
@@ -23,8 +29,12 @@ install:
   #- pip install "ansible-lint<4.0" yamllint flake8 molecule docker "pytest<3.10" "testinfra==3.0.4"
   # Configure OpenShift Binary
   - sudo wget -qO- ${OC_BINARY_URL} | sudo tar -xvz -C /bin
+  # Install hyperlink checker
+  - npm install -g markdown-link-check
 
 before_script:
+  # Check for dead-links in the docs
+  - find . -type f -name "*.md" -exec markdown-link-check --quiet --config linkcheck-config.json {} \;
   # Configure Docker
   - sudo service docker stop
   - sudo mkdir -p /etc/docker

README.md

@@ -1,3 +1,6 @@
+[![Build Status](https://travis-ci.org/redhat-cop/containers-quickstarts.svg?branch=master)](https://travis-ci.org/redhat-cop/containers-quickstarts)
+[![License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)]()
+
 # Container Quickstarts by Red Hat's Community of Practice
 
 This repository is meant to help bootstrap users of the OpenShift Container Platform to get started in building and using Source-to-Image to build applications to run in OpenShift.

TESTING.md

@@ -4,7 +4,7 @@ Containers-quickstarts is outfitted with a set of automated tests. This document
 
 ## Tesing Architecture
 
-We use Travis-CI to test this repo. You can start to examine how we set up and invoke tests by examining the [.travis.yml](/.travis.yml) file.
+We use Travis-CI to test this repo. You can start to examine how we set up and invoke tests by examining the [.travis.yml](.travis.yml) file.
 
 We have split the architect of the tests up into 4 phases:
 
@@ -13,11 +13,11 @@ We have split the architect of the tests up into 4 phases:
 3. Running [openshift-applier](https://github.com/redhat-cop/openshift-applier) to deploy a set of builds
 4. Checking `.status.phase` in each build to validate all builds end with in a `Completed` state.
 
-The 3 phases of testing are captured in a [script](/_test/setup.sh) that is executed by travis, but can also be run locally in order to validate your changes before committing code.
+The 3 phases of testing are captured in a [script](_test/setup.sh) that is executed by travis, but can also be run locally in order to validate your changes before committing code.
 
 ## Writing Tests
 
-Adding a new test to our CI is as simple as adding one or more `BuildConfig`s to the [global Applier inventory](/.applier). Currently we deploy all assets into a single namespace to make all builds "discoverable" by our test scripts.
+Adding a new test to our CI is as simple as adding one or more `BuildConfig`s to the [global Applier inventory](.applier). Currently we deploy all assets into a single namespace to make all builds "discoverable" by our test scripts.
 
 Every build that gets created will then be executed, and the test script will wait until all builds complete, and ensure that none of them fail.
 

build-s2i-executable/README.md

@@ -30,8 +30,8 @@ The requirements of this image are simple. All you need are:
 
 The openshift-applier will create the following OpenShift objects:
 * A Project named `build-s2i-executable` (see [files/projects/projects.yml](files/projects/projects.yml))
-* Two ImageStreams named `rhel7`, `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/template/build-s2i-executable.yml)).
-* One BuildConfig named `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/template/build-s2i-executable.yml)).
+* Two ImageStreams named `rhel7`, `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/templates/build-s2i-executable.yml)).
+* One BuildConfig named `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/templates/build-s2i-executable.yml)).
 
 ## Environment Variables
 

build-s2i-gows/README.md

@@ -18,7 +18,7 @@ By default our simple [demo site](demo/index.html) will be deployed.
 
 GoWS is a webserver built to do nothing more than to serve static content web sites on the smallest possible footprint. This S2I-enabled image makes this one step easier by being able to stream that content straight into the image from source.
 
-This repo contains both a `Dockerfile` for building the image and a directory of [sample content](/build-s2i-gows/demo).
+This repo contains both a `Dockerfile` for building the image and a directory of [sample content](demo).
 
 ## Bill of Materials
 
@@ -32,10 +32,10 @@ The requirements of this image are simple. All you need are:
 
 The openshift-applier will create the following OpenShift objects:
 * A Project named `s2i-gows` (see [files/projects/projects.yml](files/projects/projects.yml))
-* Three ImageStreams named `golang`, `busybox` and `gows` (see [files/imagestreams/template.yml](files/imagestreams/template.yml) and [files/builds/gows.yml](files/builds/gows.yml)).
-* Four BuildConfigs named `gows-build`, `gows-busybox`, `gows-s2i` and `gows` (see [files/builds/template.yml](files/builds/template.yml))
-* A Service named `gows` (see [files/deployments/template.yml](files/deployments/template.yml))
-* A Route named `gows` (see [files/deployments/template.yml](files/deployments/template.yml))
+* Three ImageStreams named `golang`, `busybox` and `gows` (see [.openshift/templates/imagestreams/template.yml](.openshift/templates/imagestreams/template.yml) and [.openshift/templates/builds/template.yml](.openshift/templates/builds/template.yml)).
+* Four BuildConfigs named `gows-build`, `gows-busybox`, `gows-s2i` and `gows` (see [.openshift/templates/builds/template.yml](.openshift/templates/builds/template.yml))
+* A Service named `gows` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml))
+* A Route named `gows` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml))
 
 ## Environment Variables
 

build-s2i-jekyll/README.md

@@ -8,11 +8,11 @@ This example is using the [OpenShift Applier](https://github.com/redhat-cop/open
 ## OpenShift objects
 The openshift-applier will create the following OpenShift objects:
 * A Project named `s2i-jekyll` (see [files/projects/projects.yml](files/projects/projects.yml))
-* Three ImageStreams named `ruby`, `jekyll-builder` and `openshift-playbooks` (see [files/imagestreams/template.yml](files/imagestreams/template.yml).
-* Two BuildConfigs named `jekyll-builder` and `openshift-playbooks` (see [files/builds/docker-template.yml](files/builds/docker-template.yml) and [files/builds/source-template.yml](files/builds/source-template.yml))
-* A Service named `openshift-playbooks` (see [files/deployments/template.yml](files/deployments/template.yml))
-* A Route named `openshift-playbooks` (see [files/deployments/template.yml](files/deployments/template.yml))
-* A DeploymentConfig named `openshift-playbooks` (see [files/deployments/template.yml](files/deployments/template.yml))
+* Three ImageStreams named `ruby`, `jekyll-builder` and `openshift-playbooks` (see [.openshift/templates/imagestreams/template.yml](.openshift/templates/imagestreams/template.yml).
+* Two BuildConfigs named `jekyll-builder` and `openshift-playbooks` (see [.openshift/templates/builds/docker-template.yml](.openshift/templates/builds/docker-template.yml) and [.openshift/templates/builds/source-template.yml](.openshift/templates/builds/source-template.yml))
+* A Service named `openshift-playbooks` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml))
+* A Route named `openshift-playbooks` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml))
+* A DeploymentConfig named `openshift-playbooks` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml))
 
 ## Quickstart
 
@@ -25,4 +25,4 @@ The openshift-applier will create the following OpenShift objects:
 
 Now we can `oc get routes` to get the hostname of the route that was just created, or click the link in the OpenShift Web Console, and test our newly published jekyll site.
 
->**_NOTE_**: This image is not intended to be used to serve the content provided by jekyll. It can do so, but is meant for testing purposes only. For hosting the html site produced by this image, consider using the [s2i-httpd image](/s2i-httpd/), or for someting even more light weight, check out our [Go Web Server](https://github.com/redhat-cop/gows).
+>**_NOTE_**: This image is not intended to be used to serve the content provided by jekyll. It can do so, but is meant for testing purposes only. For hosting the html site produced by this image, consider using the [s2i-httpd image](../deprecated/s2i-httpd/), or for someting even more light weight, check out our [Go Web Server](https://github.com/redhat-cop/gows).

build-s2i-liberty/README.md

@@ -41,11 +41,11 @@ This demo should be run on an installation of OpenShift Enterprise V3.7
 
 The openshift-applier will create the following OpenShift objects:
 * A project named `liberty-demo` (see [applier/projects/projects.yml](.openshift/templates/projects/projects.yml))
-* Five ImageStreams named `websphere-liberty`, `s2i-liberty`, `hello-world-artifacts`, `eap70-openshift` and `hello-world` (see [applier/templates/build.yml](.applier/templates/build.yml))
-* Three BuildConfigs named `websphere-liberty`, `hello-world-artifacts` and `hello-world` (see [applier/templates/build.yml](.applier/templates/build.yml))
-* A DeploymentConfig named `hello-world` (see [applier/templates/deployment.ym](.applier/templates/deployment.yml))
-* A Service named `hello-world` (see [applier/templates/deployment.ym](.applier/templates/deployment.yml))
-* A Route named `hello-world` (see [applier/templates/deployment.ym](.applier/templates/deployment.yml))
+* Five ImageStreams named `websphere-liberty`, `s2i-liberty`, `hello-world-artifacts`, `eap70-openshift` and `hello-world` (see [.openshift/templates/build.yml](.openshift/templates/build.yml))
+* Three BuildConfigs named `websphere-liberty`, `hello-world-artifacts` and `hello-world` (see [.openshift/templates/build.yml](.openshift/templates/build.yml))
+* A DeploymentConfig named `hello-world` (see [.openshift/templates/deployment.ym](.openshift/templates/deployment.yml))
+* A Service named `hello-world` (see [.openshift/templates/deployment.ym](.openshift/templates/deployment.yml))
+* A Route named `hello-world` (see [.openshift/templates/deployment.ym](.openshift/templates/deployment.yml))
 
 >**NOTE:** This requires permission to create new projects and that the `liberty-demo` project doesn't already exist
 

build-s2i-play/README.md

@@ -49,11 +49,11 @@ This demo should be run on an installation of OpenShift Enterprise V3
 
 The openshift-applier will create the following OpenShift objects:
 * A project named `play-demo` (see [applier/projects/projects.yml](.applier/projects/projects.yml))
-* Three ImageStreams named `rhel7`, `s2i-play` and `play-app` (see [applier/templates/build.yml](.applier/templates/build.yml))
-* Two BuildConfigs named `s2i-play` and `play-app` (see [applier/templates/build.yml](.applier/templates/build.yml))
-* A DeploymentConfig named `play-app` (see [applier/templates/deployment.yml](.applier/templates/deployment.yml))
-* A Service named `play-app` (see [applier/templates/deployment.yml](.applier/templates/deployment.yml))
-* A Route named `play-app` (see [applier/templates/deployment.yml](.applier/templates/deployment.yml))
+* Three ImageStreams named `rhel7`, `s2i-play` and `play-app` (see [.openshift/templates/build.yml](.openshift/templates/build.yml))
+* Two BuildConfigs named `s2i-play` and `play-app` (see [.openshift/templates/build.yml](.openshift/templates/build.yml))
+* A DeploymentConfig named `play-app` (see [.openshift/templates/deployment.yml](.openshift/templates/deployment.yml))
+* A Service named `play-app` (see [.openshift/templates/deployment.yml](.openshift/templates/deployment.yml))
+* A Route named `play-app` (see [.openshift/templates/deployment.yml](.openshift/templates/deployment.yml))
 
 >**NOTE:** This requires permission to create new projects and that the `play-demo` project doesn't already exist
 
@@ -106,7 +106,7 @@ oc new-project play-demo
 
 ### Produce Builder Image
 
-The Play Framework builder image can be created using the [Git](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html#source-code) or [Binary](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html#binary-source) build source
+The Play Framework builder image can be created using the [Git](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/build_inputs.html#source-code) or [Binary](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/build_inputs.html#binary-source) build source
 
 #### Git Source
 
@@ -245,6 +245,6 @@ oc delete project play-demo
 
 ## Resources
 * [Play Framework](https://www.playframework.com/)
-* [Source to Image](https://docs.openshift.com/enterprise/latest/architecture/core_concepts/builds_and_image_streams.html#source-build)
-* [Builds](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html)
-* [Developer CLI Reference](https://docs.openshift.com/enterprise/latest/cli_reference/basic_cli_operations.html)
+* [Source to Image](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/builds_and_image_streams.html#source-build)
+* [Builds](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/index.html)
+* [Developer CLI Reference](https://docs.openshift.com/container-platform/3.11/cli_reference/basic_cli_operations.html)

deprecated/kafka/README.md

@@ -30,7 +30,7 @@ The openshift-applier will create the following OpenShift objects:
 
 The following prerequisites must be met prior to beginning to build and deploy Kafka
 
-* 6 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html). 3 for Kafka and 3 for Zookeeper ([see below](#verify-storage)) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html)
+* 6 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html). 3 for Kafka and 3 for Zookeeper ([see below](#verify-storage)) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html)
 * OpenShift Command Line Tool
 * Zookeeper ([see below](#zookeeper))
 * [Openshift Applier](https://github.com/redhat-cop/openshift-applier) to build and deploy Kafka. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html)

deprecated/s2i-httpd/README.md

@@ -113,6 +113,6 @@ The application can be successfully validated if the webpage can be accessed
 
 ## Resources
 * [Apache HTTPD Web Server](https://httpd.apache.org/)
-* [Source to Image](https://docs.openshift.com/enterprise/latest/architecture/core_concepts/builds_and_image_streams.html#source-build)
-* [Builds](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html)
-* [Developer CLI Reference](https://docs.openshift.com/enterprise/latest/cli_reference/basic_cli_operations.html)
+* [Source to Image](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/builds_and_image_streams.html#source-build)
+* [Builds](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/index.html)
+* [Developer CLI Reference](https://docs.openshift.com/container-platform/3.11/cli_reference/basic_cli_operations.html)

deprecated/s2i-java/README.md

@@ -203,6 +203,6 @@ The application can be successfully validated if the webpage can be accessed
 
 ## Resources
 * [Upstream Java S2I Builder](https://github.com/fabric8io-images/s2i/tree/master/java/images/rhel)
-* [Source to Image](https://docs.openshift.com/enterprise/latest/architecture/core_concepts/builds_and_image_streams.html#source-build)
-* [Builds](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html)
-* [Developer CLI Reference](https://docs.openshift.com/enterprise/latest/cli_reference/basic_cli_operations.html)
+* [Source to Image](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/builds_and_image_streams.html#source-build)
+* [Builds](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/index.html)
+* [Developer CLI Reference](https://docs.openshift.com/container-platform/3.11/cli_reference/basic_cli_operations.html)

deprecated/zookeeper/README.md

@@ -36,8 +36,8 @@ The above steps will create the `zookeeper` project and build a Zookeeper image
 
 The openshift-applier will create the following OpenShift objects:
 * A project named `zookeeper` (see [files/projects/projects.yml](files/projects/projects.yml))
-* Two ImageStreams named `rhel` and `zookeeper` (see [files/imagestreams/images.yml](files/imagestreams/image.yml) and [files/builds/template.yml](files/builds/template.yml))
-* A BuildConfig named `zookeeper` (see [files/builds/template.yml](/files/builds/template.yml))
+* Two ImageStreams named `rhel` and `zookeeper` (see [files/imagestreams/images.yml](files/imagestreams/images.yml) and [files/builds/template.yml](files/builds/template.yml))
+* A BuildConfig named `zookeeper` (see [files/builds/template.yml](files/builds/template.yml))
 * Two Services `zookeeper` and `zookeeper-headless` (see [files/deployments/template.yml](files/deployments/template.yml))
 * A StatefulSet named `zookeeper` (see [files/deployments/template.yml](files/deployments/template.yml))
 * A ConfigMap named `zookeeper-config` (see [files/deployments/template.yml](files/deployments/template.yml))

gitlab-ce/README.md

@@ -2,7 +2,7 @@
 
 The following prerequisites must be met prior to beginning to deploy GitLab CE
 
-* 4 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html)
+* 4 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html)
 * OpenShift Command Line Tool
 * Custom SSL certificates must be generated in advance in order to provide those to the deployment process
 * [Openshift Applier](https://github.com/redhat-cop/openshift-applier/) to deploy GitLab CE. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html)

gogs/README.md

@@ -27,7 +27,7 @@ Registration is enabled until the following [issue](https://github.com/gogits/go
 
 The following prerequisites must be met prior to beginning to deploy Gogs
 
-* 2 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html). 1 for Gogs repositories data (pvc named `gogs-data`) and 1 for PostgreSQL data (pvc named `gogs-postgres-data`) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html)
+* 2 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html). 1 for Gogs repositories data (pvc named `gogs-data`) and 1 for PostgreSQL data (pvc named `gogs-postgres-data`) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html)
 * OpenShift Command Line Tool
 * [Openshift Applier](https://github.com/redhat-cop/openshift-applier/) to deploy Gogs. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html)