Update documentation about installation methods

config_template historically was published on PyPi during times before
collections were a thing. This was one of the installations methods
that is not relevant or preffered since collections are here.

That patch aims to update documentation about ways of plugin
installation as well as adding deprecation notice of PyPi.

In the futher releases we will drop publishing on PyPi.

Change-Id: Ie1cd7b305b4d82fd0fbf4568ef20ff3d0236c049

README.rst

@@ -7,14 +7,25 @@ Team and repository tags
 
 .. Change things from this point on
 
-=========================
+=================================
-OpenStack-Ansible plugins
+OpenStack-Ansible config_template
-=========================
+=================================
 
-These are the plugins the OpenStack-Ansible deployment project relies on. The
+This module is an ansible plugin that extends regular template functionality
-plugins can be added to any Ansible project by simply cloning this repository
+with the ability to override items in config, in transit, through the use
-and setting up the ``ansible.cfg`` file to point at them as additional plugins
+of a simple dictionary without having to write out various temp files on target
-for your project.
+machines.
+
+WARNING
+~~~~~~~
+
+Installation from PyPI or as a Python module is deprecated and will be removed
+in future releases.
+Please, use ansible-galaxy to install the collection.
+
+==================================
+More infromation about the project
+==================================
 
 Documentation for the project can be found at:
   https://docs.openstack.org/ansible-config_template/latest/

doc/source/index.rst

@@ -1,6 +1,6 @@
-======================
+==========================
-Config Template plugin
+Config Template collection
-======================
+==========================
 
 Synopsis
 --------
@@ -20,7 +20,7 @@ Examples
 
 Example for .conf
 ^^^^^^^^^^^^^^^^^
-The `config_template` plugin has a variety of tools available. A .conf file
+The `config_template` collection has a variety of tools available. A .conf file
 may include options that are not normally supported in an INI file, but are
 used in OpenStack, like ListOpt and MultiStrOpt.
 
@@ -146,26 +146,28 @@ Resulting file on the remote host:
   [hello]
   cruel = world
 
-Loading
+Installing collection
--------
+---------------------
 
-To use the plugin, include this role in your meta/main.yml dependencies
+To use the collection, include this in your meta/main.yml:
 
 .. code-block :: yaml
 
-   dependencies:
+   collections:
-     - role: ansible-config_template
+     - openstack.config_template
 
-Alternatively, move the role to the appropriate plugin folder location
-of your ansible configuration.
 
-Example role requirement overload for automatic plugin download
----------------------------------------------------------------
 
-The Ansible role requirement file can be used to overload the
+Also the Ansible requirement file can be used with the
-``ansible-galaxy`` command to automatically fetch the plugins for
+``ansible-galaxy`` command to automatically fetch the collections for
 you in a given project. To do this add the following lines to your
-``ansible-role-requirements.yml`` file.
+``requirements.yml`` file.
 
 .. literalinclude:: ../../examples/ansible-role-requirements.yml
    :language: yaml
+
+After that simple run the following command to get requirements installed:
+
+  .. code-block :: shell
+
+    $ ansible-galaxy install -r requirements.yml

examples/ansible-role-requirements.yml

@@ -1,4 +1,4 @@
-- name: ansible-config_template
+collections:
-  src: https://opendev.org/openstack/ansible-config_template
+  - name: https://opendev.org/openstack/ansible-config_template
-  scm: git
+    version: master
-  version: master
+    type: git

releasenotes/notes/pypi_deprecation-93d9628dcdd76f93.yaml

@@ -0,0 +1,6 @@
+---
+deprecations:
+  - |
+    Installation from PyPI or as a Python module is deprecated and will be removed
+    in future releases.
+    Please, use ``ansible-galaxy`` for plugin installation.