airship/armada
Code Issues Proposed changes

Docs: Fix broken README/getting-started doc links

Browse Source 
Change-Id: I75f6e299f45e85029a3da28a9ce8e2a3c5525a92
This commit is contained in:
Felipe Monteiro 2018-02-13 20:07:47 +00:00 committed by Tin Lam
parent 13c4e3372a
commit d857125de5
2 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.rst
View File

@ -75,7 +75,7 @@ Manual Installation
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
For a comprehensive manual installation guide, please For a comprehensive manual installation guide, please
see :ref:`dev-getting-started`. see `Manual Install Guide`_.
Usage Usage
^^^^^ ^^^^^
@ -93,8 +93,7 @@ Which should output something like this::
... ...
For more information on how to install and use Armada, please reference: For more information on how to install and use Armada, please reference:
:ref:`guide-use-armada`. `Armada Quickstart`_.
Integration Points Integration Points
------------------ ------------------
@ -114,6 +113,8 @@ Further Reading
`Undercloud Platform (UCP) <https://github.com/att-comdev/ucp-integration>`_. `Undercloud Platform (UCP) <https://github.com/att-comdev/ucp-integration>`_.
.. _Manual Install Guide: http://armada-helm.readthedocs.io/en/latest/development/getting-started.html#developer-install-guide
.. _Armada Quickstart: http://armada-helm.readthedocs.io/en/latest/operations/guide-use-armada.html
.. _kubectl: https://kubernetes.io/docs/user-guide/kubectl/kubectl_config/ .. _kubectl: https://kubernetes.io/docs/user-guide/kubectl/kubectl_config/
.. _Tiller: https://docs.helm.sh/using_helm/#easy-in-cluster-installation .. _Tiller: https://docs.helm.sh/using_helm/#easy-in-cluster-installation
.. _Deckhand: https://github.com/openstack/deckhand .. _Deckhand: https://github.com/openstack/deckhand

8
docs/source/development/getting-started.rst
View File

@ -60,11 +60,7 @@ Armada requires a Kubernetes cluster to be deployed, along with `kubectl`_,
#. Install Kubernetes (k8s) and deploy a k8s cluster. #. Install Kubernetes (k8s) and deploy a k8s cluster.
This can be accomplished by cloning the Reference the :ref:`k8s-cluster-management` section below for help.
`k8s repo <https://github.com/kubernetes/kubernetes>_` and running
``kube-up.sh`` in ``kubernetes/cluster``.
Alternatively, reference the :ref:`k8s-cluster-management` section below.
#. Install and configure `kubectl`_ #. Install and configure `kubectl`_
@ -272,7 +268,7 @@ included beneath each bullet.
$ sudo apt-get install python3-dev -y $ sudo apt-get install python3-dev -y
.. _Bandit: https://github.com/openstack/bandit .. _Bandit: https://github.com/openstack/bandit
.. _kubectl: https://kubernetes.io/docs/user-guide/kubectl/kubectl_config/ .. _kubectl: https://kubernetes.io/docs/tasks/tools/install-kubectl/
.. _Helm: https://docs.helm.sh/using_helm/#installing-helm .. _Helm: https://docs.helm.sh/using_helm/#installing-helm
.. _Keystone: https://github.com/openstack/keystone .. _Keystone: https://github.com/openstack/keystone
.. _Tiller: https://docs.helm.sh/using_helm/#easy-in-cluster-installation .. _Tiller: https://docs.helm.sh/using_helm/#easy-in-cluster-installation