airship/armada
Code Issues Proposed changes

Merge "docs(links): Fix broken links"

Browse Source
This commit is contained in:
Alexis Rivera DeLa Torre 2017-11-27 14:59:21 -05:00 committed by Gerrit Code Review
commit c7a4620e8e
4 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.rst
View File

@ -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 <CODE_OF_CONDUCT.rst>`_. Please
familiarize yourself with it before contributing.
`Contributor Convenant Code of Conduct <https://github.com/att-comdev/armada/
blob/master/CODE_OF_CONDUCT.rst>`_. 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 <http://github.com/att-comdev/armada/issues>`_ page. Before submitting
an issue, please check the `troubleshooting guide <docs/source/operations/
guide-troubleshooting.rst>`_. If the issue still persists, please file an
official bug report on the `issues <http://github.com/att-comdev/armada/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 <http://armada-helm.readthedocs.io/en/latest/operations/
guide-troubleshooting.html>`_. If the issue still persists, please file an
official bug report on the `issues <http://github.com/att-comdev/armada/
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 <docs/source/development/getting-started.rst>`_
`developers' guide <http://armada-helm.readthedocs.io/en/latest/
readme.html#getting-started>`_
Armada accepts patches through GerritHub changes. Each commit pushed to
GerritHub is recognized as a "change" (the equivalent of a GitHub pull

7
README.rst
View File

@ -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 <docs/source/operations/guide-use-armada.rst>`_
Using armada `docs <http://armada-helm.readthedocs.io/en/latest/operations/
guide-use-armada.html>`_
Getting Started
---------------
Get started guide can be found in our `Getting Started docs <docs/source/development/getting-started.rst>`_
Get started guide can be found in our
`Getting Started docs <http://armada-helm.readthedocs.io/en/latest/
readme.html#getting-started>`_
Usage
-----

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

@ -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 <https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/>`_
`Kubeadm-AIO <https://github.com/openstack/openstack-helm/tree/master/tools/kubeadm-aio>`_
`Kubeadm-AIO <https://docs.openstack.org/openstack-helm/latest/install/
developer/all-in-one.html>`_

3
docs/source/operations/guide-use-armada.rst
View File

@ -8,7 +8,8 @@ Kubernetes Cluster
`Tiller Service <http://github.com/kubernetes/helm>`_
`Armada.yaml <guide-build-armada-yaml.rst>`_
`Armada.yaml <http://armada-helm.readthedocs.io/en/latest/operations/
guide-build-armada-yaml.html>`_
.. note::