Change-Id: I11795099e91f4c82a944e12950d97a5c1a7c8655changes/77/663177/1
@@ -47,8 +47,8 @@ That's it ! | |||
## Live demos | |||
You can find live demos deployed by the built-in [ara_api](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-api.html) | |||
and [ara_web](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-web.html) | |||
You can find live demos deployed by the built-in [ara_api](https://ara.readthedocs.io/en/latest/ansible-role-ara-api.html) | |||
and [ara_web](https://ara.readthedocs.io/en/latest/ansible-role-ara-web.html) | |||
Ansible roles at https://api.demo.recordsansible.org and https://web.demo.recordsansible.org. | |||
## ARA is free and open source | |||
@@ -58,7 +58,7 @@ ARA is free and open source under the GPLv3 license. | |||
The code review and CI infrastructure is hosted by [OpenDev](https://opendev.org). | |||
You can participate in [code reviews](https://review.opendev.org/#/q/project:%255Erecordsansible/.*) | |||
and learn how you can contribute your first patch in the [contributors documentation](https://ara.readthedocs.io/en/feature-1.0/contributing.html). | |||
and learn how you can contribute your first patch in the [contributors documentation](https://ara.readthedocs.io/en/latest/contributing.html). | |||
## ARA is tested, stable and production ready | |||
@@ -78,4 +78,4 @@ You can browse your ARA reports locally from a sqlite database without ever leav | |||
Need to aggregate data from multiple locations ? | |||
You can run an API server and hook it up to a database engine like | |||
[PostgreSQL or MySQL](https://ara.readthedocs.io/en/feature-1.0/api-configuration.html#ara-database-engine). | |||
[PostgreSQL or MySQL](https://ara.readthedocs.io/en/latest/api-configuration.html#ara-database-engine). |
@@ -59,8 +59,8 @@ the Ansible playbooks to deploy it ! | |||
ARA 1.0 will ship with two built-in Ansible roles: | |||
- [ansible-role-ara-api](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-api.html) | |||
- [ansible-role-ara-web](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-web.html) | |||
- [ansible-role-ara-api](https://ara.readthedocs.io/en/latest/ansible-role-ara-api.html) | |||
- [ansible-role-ara-web](https://ara.readthedocs.io/en/latest/ansible-role-ara-web.html) | |||
These roles work are already in use to deploy | |||
[api.demo.recordsansible.org](https://api.demo.recordsansible.org) as |
@@ -52,20 +52,20 @@ If you want a quick start, you can have a look at the | |||
[README](https://github.com/ansible-community/ara/tree/feature/1.0#quickstart) | |||
or there is otherwise plenty of documentation available to get started: | |||
- [Installing the 1.0 pre-release](https://ara.readthedocs.io/en/feature-1.0/installation.html) | |||
- [Configuring Ansible to use ARA](https://ara.readthedocs.io/en/feature-1.0/ansible-configuration.html) | |||
- [Configuring the ARA Ansible plugins](https://ara.readthedocs.io/en/feature-1.0/ara-plugin-configuration.html) | |||
- [Customizing the API server configuration](https://ara.readthedocs.io/en/feature-1.0/api-configuration.html) | |||
- [Setting up authentication and security considerations](https://ara.readthedocs.io/en/feature-1.0/api-security.html) | |||
- [API endpoint documentation and object relationships](https://ara.readthedocs.io/en/feature-1.0/api-documentation.html) | |||
- [How to use the API with the built-in API clients](https://ara.readthedocs.io/en/feature-1.0/api-usage.html) | |||
- [Architecture and workflows: how ARA records data](https://ara.readthedocs.io/en/feature-1.0/architecture.html) | |||
- [Installing the 1.0 pre-release](https://ara.readthedocs.io/en/latest/installation.html) | |||
- [Configuring Ansible to use ARA](https://ara.readthedocs.io/en/latest/ansible-configuration.html) | |||
- [Configuring the ARA Ansible plugins](https://ara.readthedocs.io/en/latest/ara-plugin-configuration.html) | |||
- [Customizing the API server configuration](https://ara.readthedocs.io/en/latest/api-configuration.html) | |||
- [Setting up authentication and security considerations](https://ara.readthedocs.io/en/latest/api-security.html) | |||
- [API endpoint documentation and object relationships](https://ara.readthedocs.io/en/latest/api-documentation.html) | |||
- [How to use the API with the built-in API clients](https://ara.readthedocs.io/en/latest/api-usage.html) | |||
- [Architecture and workflows: how ARA records data](https://ara.readthedocs.io/en/latest/architecture.html) | |||
There are even built-in Ansible roles to help you set up an API server as well | |||
as the new web interface: | |||
- [ansible-role-ara-api](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-api.html) | |||
- [ansible-role-ara-web](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-web.html) | |||
- [ansible-role-ara-api](https://ara.readthedocs.io/en/latest/ansible-role-ara-api.html) | |||
- [ansible-role-ara-web](https://ara.readthedocs.io/en/latest/ansible-role-ara-web.html) | |||
In fact, these roles are the ones used to deploy the live demos on | |||
[api.demo.recordsansible.org](https://api.demo.recordsansible.org/) and |
@@ -36,24 +36,24 @@ If you want a quick start, you can have a look at the | |||
[README](https://github.com/ansible-community/ara/tree/feature/1.0#quickstart) | |||
or there is otherwise plenty of documentation available to get started: | |||
- [Frequently asked questions](https://ara.readthedocs.io/en/feature-1.0/faq.html) | |||
- [Installing ARA](https://ara.readthedocs.io/en/feature-1.0/installation.html) | |||
- [Configuring Ansible to use ARA](https://ara.readthedocs.io/en/feature-1.0/ansible-configuration.html) | |||
- [Configuring the ARA Ansible plugins](https://ara.readthedocs.io/en/feature-1.0/ara-plugin-configuration.html) | |||
- [Customizing the API server configuration](https://ara.readthedocs.io/en/feature-1.0/api-configuration.html) | |||
- [Setting up authentication and security considerations](https://ara.readthedocs.io/en/feature-1.0/api-security.html) | |||
- [API endpoint documentation and object relationships](https://ara.readthedocs.io/en/feature-1.0/api-documentation.html) | |||
- [How to use the API with the built-in API clients](https://ara.readthedocs.io/en/feature-1.0/api-usage.html) | |||
- [Frequently asked questions](https://ara.readthedocs.io/en/latest/faq.html) | |||
- [Installing ARA](https://ara.readthedocs.io/en/latest/installation.html) | |||
- [Configuring Ansible to use ARA](https://ara.readthedocs.io/en/latest/ansible-configuration.html) | |||
- [Configuring the ARA Ansible plugins](https://ara.readthedocs.io/en/latest/ara-plugin-configuration.html) | |||
- [Customizing the API server configuration](https://ara.readthedocs.io/en/latest/api-configuration.html) | |||
- [Setting up authentication and security considerations](https://ara.readthedocs.io/en/latest/api-security.html) | |||
- [API endpoint documentation and object relationships](https://ara.readthedocs.io/en/latest/api-documentation.html) | |||
- [How to use the API with the built-in API clients](https://ara.readthedocs.io/en/latest/api-usage.html) | |||
You might also want to take a look at ARA features such as | |||
[playbook names and labels](https://ara.readthedocs.io/en/feature-1.0/playbook-names-and-labels.html) | |||
and the [ara_record action module to record arbitrary data](https://ara.readthedocs.io/en/feature-1.0/ara-record.html). | |||
[playbook names and labels](https://ara.readthedocs.io/en/latest/playbook-names-and-labels.html) | |||
and the [ara_record action module to record arbitrary data](https://ara.readthedocs.io/en/latest/ara-record.html). | |||
There are even built-in Ansible roles to help you set up an API server as well | |||
as the new web interface: | |||
- [ansible-role-ara-api](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-api.html) | |||
- [ansible-role-ara-web](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-web.html) | |||
- [ansible-role-ara-api](https://ara.readthedocs.io/en/latest/ansible-role-ara-api.html) | |||
- [ansible-role-ara-web](https://ara.readthedocs.io/en/latest/ansible-role-ara-web.html) | |||
In fact, these roles are the ones used to deploy the live demos on | |||
[api.demo.recordsansible.org](https://api.demo.recordsansible.org/) and |