From 9be0f99adb2e9cb00a0ff0094929a32e4682bb50 Mon Sep 17 00:00:00 2001 From: drewwalters96 Date: Mon, 20 Nov 2017 18:54:11 -0600 Subject: [PATCH] docs(links): Fix broken links - Links to .rst files converted to external links to the official Armada documentation to avoid broken links from appearing on GitHub and Read the Docs Closes #174 Change-Id: I190884f71d44cfb3ec133bf779a718185394dec0 --- CONTRIBUTING.rst | 19 +++++++++++-------- README.rst | 7 +++++-- docs/source/development/getting-started.rst | 4 +++- docs/source/operations/guide-use-armada.rst | 3 ++- 4 files changed, 21 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b9f671c9..ec00d5ca 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -7,8 +7,9 @@ involved in contributing to Armada. Code of Conduct --------------- By contributing to Armada, you are agreeing to uphold the -`Contributor Convenant Code of Conduct `_. Please -familiarize yourself with it before contributing. +`Contributor Convenant Code of Conduct `_. Please familiarize yourself with it +before contributing. Support ------- @@ -21,11 +22,12 @@ Reporting an Issue ------------------ All bugs and features are tracked using the Armada GitHub `issues `_ page. Before submitting -an issue, please check the `troubleshooting guide `_. If the issue still persists, please file an -official bug report on the `issues `_ -page if one does not already exist. When filing an issue, please follow the issue -template and be as descriptive as possible. +an issue, please check the +`troubleshooting guide `_. If the issue still persists, please file an +official bug report on the `issues `_ page if one does not already exist. When filing an issue, please +follow the issue template and be as descriptive as possible. After an issue is created, project maintainers will assign labels indicating the issue type. @@ -75,7 +77,8 @@ Submitting a Patch ------------------ This section focuses on the workflow and lifecycle of Armada patches. Development specific information can be found in the Armada -`developers' guide `_ +`developers' guide `_ Armada accepts patches through GerritHub changes. Each commit pushed to GerritHub is recognized as a "change" (the equivalent of a GitHub pull diff --git a/README.rst b/README.rst index 16276580..2d85d7da 100644 --- a/README.rst +++ b/README.rst @@ -21,12 +21,15 @@ Installation docker run -d --net host -p 8000:8000 --name armada -v ~/.kube/config:/armada/.kube/config -v $(pwd)/examples/:/examples quay.io/attcomdev/armada:latest -Using armada `docs `_ +Using armada `docs `_ Getting Started --------------- -Get started guide can be found in our `Getting Started docs `_ +Get started guide can be found in our +`Getting Started docs `_ Usage ----- diff --git a/docs/source/development/getting-started.rst b/docs/source/development/getting-started.rst index be9ce8b9..381a9135 100644 --- a/docs/source/development/getting-started.rst +++ b/docs/source/development/getting-started.rst @@ -69,6 +69,7 @@ From the directory of the forked repository: .. code-block:: bash + # Testing your armada code # The tox command will execute lint, bandit, cover @@ -112,4 +113,5 @@ We recommend: `Kubeadm `_ -`Kubeadm-AIO `_ +`Kubeadm-AIO `_ diff --git a/docs/source/operations/guide-use-armada.rst b/docs/source/operations/guide-use-armada.rst index f77afb9b..aa21ff28 100644 --- a/docs/source/operations/guide-use-armada.rst +++ b/docs/source/operations/guide-use-armada.rst @@ -8,7 +8,8 @@ Kubernetes Cluster `Tiller Service `_ -`Armada.yaml `_ +`Armada.yaml `_ .. note::