Merge "Complete update README"

README.md

@@ -1,49 +0,0 @@
-#### Ansible systemd_service
-
-This Ansible role that installs and configures systemd unit files and all of its
-corresponding services. This role requires the ``openstack-ansible-plugins``
-repository to be available on your local system. The Ansible galaxy resolver
-will not retrieve this role for you. To get this role in place clone the
-plugins repository **before** installing this role.
-
-``` bash
-# git clone https://github.com/openstack/openstack-ansible-plugins /etc/ansible/roles/plugins
-```
-Release notes for the project can be found at:
-  https://docs.openstack.org/releasenotes/ansible-role-systemd_service
-
-You can also use the ``ansible-galaxy`` command on the ``requirements.yml`` file.
-
-``` bash
-# ansible-galaxy install -r requirements.yml
-```
-
-----
-
-###### Example playbook
-
-``` yaml
-- name: Create a systemd unit file for ServiceX
-  hosts: localhost
-  become: true
-  roles:
-    - role: "systemd_service"
-      systemd_services:
-        # Normal Service
-        - service_name: ServiceX
-          execstarts:
-            - /path/ServiceX --flag1
-
-        # Timer Service (AKA CRON)
-        - service_name: TimerServiceX
-          execstarts:
-            - /path/TimerServiceX --flag1
-          timer:
-            state: "started"
-            options:
-              OnBootSec: 30min
-              OnUnitActiveSec: 1h
-              Persistent: true
-      tags:
-        - servicex-init
-```

README.rst

@@ -0,0 +1,21 @@
+==========================================
+systemd_service role for OpenStack-Ansible
+==========================================
+
+This Ansible role that installs and configures systemd unit files
+and all of its corresponding services.
+
+Documentation for the project can be found at:
+  https://docs.openstack.org/ansible-role-systemd_service/latest
+
+Release notes for the project can be found at:
+  https://docs.openstack.org/releasenotes/ansible-role-systemd_service/
+
+The project source code repository is located at:
+  https://opendev.org/openstack/ansible-role-systemd_service
+
+The project home is at:
+  https://launchpad.net/openstack-ansible
+
+The project bug tracker is located at:
+  https://bugs.launchpad.net/openstack-ansible

doc/source/index.rst

@@ -2,8 +2,17 @@
 systemd_service role for OpenStack-Ansible
 ==========================================
 
-:tags: openstack, systemd_service, cloud, ansible
-:category: \*nix
+This Ansible role that installs and configures systemd
+unit files and all of its corresponding services.
+This role requires the ``ansible-config_template`` collection
+to be available on your local system.
+To get collection you can use use the ``ansible-galaxy`` command on the
+``requirements.yml`` file.. You need to install collection **before**
+running this role.
+
+.. code-block:: bash
+
+    ansible-galaxy install -r requirements.yml
 
 This role will configure Systemd units: