From cab932f0ed388d2ca80a19d54da0c45cf0459010 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Tue, 4 Jun 2019 19:52:18 -0400 Subject: [PATCH] Switch default branch from feature/1.0 to master This updates the doc and git branches to match master instead of feature/1.0. Change-Id: Ifc98157328b2f9f56055fa0cdcfea5db5180fb7f --- .gitreview | 2 +- .zuul.d/zuul.yaml | 2 ++ README.rst | 6 +++--- ara/setup/README.rst | 2 +- doc/source/installation.rst | 15 ++++++++------- roles/ara_api/README.rst | 2 +- roles/ara_api/defaults/main.yaml | 2 +- roles/ara_tests/README.rst | 2 +- roles/ara_web/README.rst | 2 +- 9 files changed, 19 insertions(+), 16 deletions(-) diff --git a/.gitreview b/.gitreview index 36da8e69..ad67a1e6 100644 --- a/.gitreview +++ b/.gitreview @@ -2,4 +2,4 @@ host=review.opendev.org port=29418 project=recordsansible/ara -defaultbranch=feature/1.0 +defaultbranch=master diff --git a/.zuul.d/zuul.yaml b/.zuul.d/zuul.yaml index 8c55feb4..15089767 100644 --- a/.zuul.d/zuul.yaml +++ b/.zuul.d/zuul.yaml @@ -219,3 +219,5 @@ post: jobs: - ara-upload-git-mirror + +# This line left intentionally blank for reloading Zuul jobs after branch change diff --git a/README.rst b/README.rst index 11ea953d..07e6d92c 100644 --- a/README.rst +++ b/README.rst @@ -47,14 +47,14 @@ Live demos You can find live demos deployed by the built-in ara_api_ and ara_web_ Ansible roles at https://api.demo.recordsansible.org and https://web.demo.recordsansible.org. -.. _ara_api: https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-api.html -.. _ara_web: https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-web.html +.. _ara_api: https://ara.readthedocs.io/en/latest/ansible-role-ara-api.html +.. _ara_web: https://ara.readthedocs.io/en/latest/ansible-role-ara-web.html Documentation ============= Documentation for installing, configuring, running and using ARA is -available on `readthedocs.io `_. +available on `readthedocs.io `_. Community and getting help ========================== diff --git a/ara/setup/README.rst b/ara/setup/README.rst index c2fabde4..b1cbba07 100644 --- a/ara/setup/README.rst +++ b/ara/setup/README.rst @@ -2,4 +2,4 @@ This directory contains scripts meant to help configuring ARA with Ansible. For more information, visit the documentation_. -.. _documentation: http://ara.readthedocs.io/en/latest/configuration.html +.. _documentation: https://ara.readthedocs.io/en/latest/ansible-configuration.html diff --git a/doc/source/installation.rst b/doc/source/installation.rst index bbc206d9..e2a1666b 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -30,26 +30,27 @@ in order to avoid conflicts with your Linux distribution python packages. python3 -m venv ~/.ara/virtualenv -To install the latest pre-release for ARA 1.0 from PyPi_: +To install the latest release of ARA from PyPi_: .. code-block:: bash # With the API server dependencies - ~/.ara/virtualenv/bin/pip install --pre ara[server] + ~/.ara/virtualenv/bin/pip install ara[server] # Without the API server dependencies - ~/.ara/virtualenv/bin/pip install --pre ara + ~/.ara/virtualenv/bin/pip install ara -Installing from source is possible by using the -`feature/1.0 `_ branch: +Installing from source is possible by using the git repository: .. code-block:: bash # With the API server dependencies - ~/.ara/virtualenv/bin/pip install git+https://github.com/ansible-community/ara@feature/1.0[server] + # (Suffixes don't work when supplying the direct git URL) + git clone https://github.com/ansible-community/ara ara-src + pip install ./ara-src[server] # Without the API server dependencies - ~/.ara/virtualenv/bin/pip install git+https://github.com/ansible-community/ara@feature/1.0 + ~/.ara/virtualenv/bin/pip install git+https://github.com/ansible-community/ara .. _PyPi: https://pypi.org/project/ara/ diff --git a/roles/ara_api/README.rst b/roles/ara_api/README.rst index 3fb3c7c8..9084077f 100644 --- a/roles/ara_api/README.rst +++ b/roles/ara_api/README.rst @@ -12,7 +12,7 @@ It is currently tested and supported against Ubuntu 18.04 and Fedora 29. Role Variables -------------- -See `defaults/main.yaml `_. +See `defaults/main.yaml `_. .. literalinclude:: ../../roles/ara_api/defaults/main.yaml :language: yaml+jinja diff --git a/roles/ara_api/defaults/main.yaml b/roles/ara_api/defaults/main.yaml index e9aca0e6..e9b11f51 100644 --- a/roles/ara_api/defaults/main.yaml +++ b/roles/ara_api/defaults/main.yaml @@ -47,7 +47,7 @@ ara_api_source_checkout: "{{ ara_api_root_dir }}/git/ara" # When installing from PyPi, it would be a version number that has been released. # When using "latest" as the source version, HEAD will be used # When using "latest" as the pypi version, the latest release will be used -ara_api_version: feature/1.0 +ara_api_version: master # The frontend/web server for serving the ARA API # It is recommended to specify a web server when deploying a production environment. diff --git a/roles/ara_tests/README.rst b/roles/ara_tests/README.rst index 5aad65bb..de10ba1a 100644 --- a/roles/ara_tests/README.rst +++ b/roles/ara_tests/README.rst @@ -7,7 +7,7 @@ tests that do not require superuser privileges. Role Variables -------------- -See `defaults/main.yaml `_. +See `defaults/main.yaml `_. .. literalinclude:: ../../roles/ara_tests/defaults/main.yaml :language: yaml+jinja diff --git a/roles/ara_web/README.rst b/roles/ara_web/README.rst index 100d1703..158dc1a9 100644 --- a/roles/ara_web/README.rst +++ b/roles/ara_web/README.rst @@ -12,7 +12,7 @@ It is currently tested and supported against Ubuntu 18.04 and Fedora 29. Role Variables -------------- -See `defaults/main.yaml `_. +See `defaults/main.yaml `_. .. literalinclude:: ../../roles/ara_web/defaults/main.yaml :language: yaml+jinja