diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6e9457b..42c55f6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,11 +1,9 @@ -repo_build -######## +=================================================== +OpenStack-Ansible repo_build contributor guidelines +=================================================== -contributor guidelines -^^^^^^^^^^^^^^^^^^^^^^ - -Filing Bugs ------------ +Filing bugs +~~~~~~~~~~~ Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible" @@ -18,8 +16,8 @@ When submitting a bug, or working on a bug, please ensure the following criteria * Steps to reproduce the problem if possible. -Submitting Code ---------------- +Submitting code +~~~~~~~~~~~~~~~ Changes to the project should be submitted for review via the Gerrit tool, following the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow" @@ -28,7 +26,7 @@ Pull requests submitted through GitHub will be ignored and closed without regard Extra ------ +~~~~~ Tags: If it's a bug that needs fixing in a branch in addition to Master, add a '\-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete. @@ -41,7 +39,7 @@ Importance: Style guide ------------ +~~~~~~~~~~~ When creating tasks and other roles for use in Ansible please create them using the YAML dictionary format. @@ -71,7 +69,7 @@ Usage of the ">" and "|" operators should be limited to Ansible conditionals and Issues ------- +~~~~~~ When submitting an issue, or working on an issue please ensure the following criteria are met: * The description clearly states or describes the original problem or root cause of the problem. diff --git a/README.rst b/README.rst index 02135b0..b15c7f7 100644 --- a/README.rst +++ b/README.rst @@ -1,13 +1,12 @@ -==================== -OpenStack repo build -==================== +============================ +OpenStack-Ansible repo_build +============================ -Role to deploy a repository build for both python packages and git sources. +Ansible role that builds a repository of Git repositories, Python +wheels, and virtualenvs. -.. code:: yaml +Documentation for the project can be found at: + http://docs.openstack.org/developer/openstack-ansible-repo_build - - name: Setup repo builds - hosts: repo_all - user: root - roles: - - { role: "repo_build", tags: [ "repo-build" ] } +The project home is at: + http://launchpad.net/openstack-ansible diff --git a/doc/source/index.rst b/doc/source/index.rst index 102b1af..b3481d8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,10 +1,24 @@ -``repo_build`` docs -=================== +============================ +OpenStack-Ansible repo_build +============================ -Ansible role for building a python repository of wheels and venvs. +Ansible role that builds a repository of Git repositories, Python +wheels, and virtualenvs. -Basic role example +Default variables +~~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../defaults/main.yml + :language: yaml + :start-after: under the License. + +Required variables ~~~~~~~~~~~~~~~~~~ +None. + +Example playbook +~~~~~~~~~~~~~~~~ + .. literalinclude:: ../../examples/playbook.yml :language: yaml diff --git a/example/playbook.yml b/example/playbook.yml deleted file mode 100644 index 1ace022..0000000 --- a/example/playbook.yml +++ /dev/null @@ -1,2 +0,0 @@ - - role: "repo_build" - ROLE_VARS... \ No newline at end of file diff --git a/examples/playbook.yml b/examples/playbook.yml new file mode 100644 index 0000000..501599d --- /dev/null +++ b/examples/playbook.yml @@ -0,0 +1,5 @@ +- name: Set up repo builds + hosts: repo_all + user: root + roles: + - { role: "repo_build", tags: [ "repo-build" ] } diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 51c775b..c6e106a 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -================================ - OpenStack-Ansible Release Notes -================================ +========================================== +OpenStack-Ansible repo_build release notes +========================================== .. toctree:: :maxdepth: 1 diff --git a/releasenotes/source/mitaka.rst b/releasenotes/source/mitaka.rst index 0dc585c..0b84275 100644 --- a/releasenotes/source/mitaka.rst +++ b/releasenotes/source/mitaka.rst @@ -1,6 +1,6 @@ -============================= - Mitaka Series Release Notes -============================= +=========================== +Mitaka series release notes +=========================== .. release-notes:: :branch: origin/stable/mitaka diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst index cd22aab..d9855f0 100644 --- a/releasenotes/source/unreleased.rst +++ b/releasenotes/source/unreleased.rst @@ -1,5 +1,5 @@ -============================== - Current Series Release Notes -============================== +============================ +Current series release notes +============================ .. release-notes:: diff --git a/setup.cfg b/setup.cfg index 03bb4ad..23ac342 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://www.openstack.org/ +home-page = http://docs.openstack.org/developer/openstack-ansible-repo_build classifier = Intended Audience :: Developers Intended Audience :: System Administrators