Merge branch 'devel'

changelog/CHANGELOG-v2.6.rst

@@ -5,6 +5,24 @@ vbotka.apache 2.6 Release Notes
 .. contents:: Topics
 
 
+2.6.1
+=====
+
+Release Summary
+---------------
+Bugfix release with updated docs.
+
+Major Changes
+-------------
+
+Minor Changes
+-------------
+* Bump docs version.
+* Fix docs formatting.
+* Fix docs links.
+* Fix handler notifications.
+
+
 2.6.0
 =====
 

docs/source/conf.py

@@ -58,7 +58,7 @@
 # The short X.Y version.
 version = '2.6'
 # The full version, including alpha/beta/rc tags.
-release = '2.6.0'
+release = '2.6.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/guide.rst

@@ -5,7 +5,7 @@
 
 User's guide
 ************
-.. contents:: Topics
+.. contents:: Contents
    :depth: 3
 
 
@@ -16,13 +16,13 @@ Introduction
 
 The role will install and configure Apache web server
 
-* Ansible role: `Apache <https://galaxy.ansible.com/vbotka/apache/>`_
+* Ansible role: `vbotka.apache <https://galaxy.ansible.com/vbotka/apache/>`_
 * Supported systems: `FreeBSD <https://www.freebsd.org/>`_
 * Requirements:
 
-    * `vbotka.ansible_lib <https://galaxy.ansible.com/vbotka/ansible_lib/>`__
-    * `jtyr.config_encoder_filters <https://galaxy.ansible.com/jtyr/config_encoder_filters/>`__
-    * `community.general <https://github.com/ansible-collections/community.general/>`__
+    * `vbotka.ansible_lib <https://galaxy.ansible.com/vbotka/ansible_lib>`_
+    * `jtyr.config_encoder_filters <https://galaxy.ansible.com/jtyr/config_encoder_filters/>`_
+    * `community.general <https://github.com/ansible-collections/community.general/>`_
 
 The user is expected to have basic knowledge of Ansible
 
@@ -47,23 +47,22 @@ and install it ::
 
     shell> ansible-galaxy role install vbotka.apache
 
-Together with the role ``vbotka.apache`` dependent role `jtyr.config_encoder_filters
-<https://galaxy.ansible.com/jtyr/config_encoder_filters>`_ will be installed (see
+Together with the role `vbotka.apache`_ dependent role `jtyr.config_encoder_filters`_ will be installed (see
 meta/main.yml). This role provides the filter `encode_apache
 <https://github.com/jtyr/ansible-config_encoder_filters#id6>`_ used to encode YAML configuration
 data to the Apache format.
 
-Install the library `vbotka.ansible_lib  <https://galaxy.ansible.com/vbotka/ansible_lib>`_ ::
+Install the library `vbotka.ansible_lib`_, if necessary ::
 
     shell> ansible-galaxy role install vbotka.ansible_lib
 
-Install the collection `community.general <https://docs.ansible.com/ansible/latest/collections/community/general/>`_ ::
+Install the collection `community.general`_ ::
 
     shell> ansible-galaxy collection install community.general
 
 .. seealso::
 
-   * For details on how to install specific versions from various sources see `Installing content <https://galaxy.ansible.com/docs/using/installing.html>`__.
+   * For details on how to install specific versions from various sources see `Installing content <https://galaxy.ansible.com/docs/using/installing.html>`_.
 
    * Take a look at other roles ``shell> ansible-galaxy search --author=vbotka``
 
@@ -101,10 +100,10 @@ Simple playbook to install and configure Apache at srv.example.com (2)
 .. seealso::
 
    * For details see `Connection Plugins
-     <https://docs.ansible.com/ansible/latest/plugins/connection.html>`__ (4-5) and
+     <https://docs.ansible.com/ansible/latest/plugins/connection.html>`_ (4-5) and
 
    * `Understanding Privilege Escalation
-     <https://docs.ansible.com/ansible/latest/user_guide/become.html#understanding-privilege-escalation>`__ (6-8).
+     <https://docs.ansible.com/ansible/latest/user_guide/become.html#understanding-privilege-escalation>`_ (6-8).
 
 
 .. _ug_tags:
@@ -785,8 +784,8 @@ Notes
 ^^^^^
 .. note::
 
-   * | The default value is
-     | ``apache_httpd_conf_modules:``
-     |   ``- {module: "socache_shmcb_module", mod: "mod_socache_shmcb.so"}``
-   * For details see annotated source u:ref:`as_httpd-modules.yml`, or
-   * GitHub `httpd-modules.yml <https://github.com/vbotka/ansible-apache/blob/master/tasks/httpd-modules.yml>`_
+   | * The default value is
+   |   ``apache_httpd_conf_modules:``
+   |     ``- { module: socache_shmcb_module, mod: mod_socache_shmcb.so }``
+   | * For details see annotated source :ref:`as_httpd-modules.yml`, or
+   | * GitHub `httpd-modules.yml <https://github.com/vbotka/ansible-apache/blob/master/tasks/httpd-modules.yml>`_

tasks/httpd-alias.yml

@@ -8,7 +8,7 @@
         {{ item }}
         {% endfor %}
     backup: "{{ apache_backup_conf }}"
-  notify: reload apache
+  notify: Reload apache
   when: apache_alias | length > 0
 
 # EOF

tasks/httpd-confd-includes.yml

@@ -26,6 +26,6 @@
     mode: "{{ apache_data_mode }}"
     backup: "{{ apache_backup_conf }}"
   loop: "{{ al_include_confd_vars_list }}"
-  notify: reload apache
+  notify: Reload apache
 
 # EOF

tasks/httpd-confd-vhosts.yml

@@ -34,7 +34,7 @@
     mode: "{{ apache_data_mode }}"
     backup: "{{ apache_backup_conf }}"
   loop: "{{ al_include_confd_vars_list }}"
-  notify: reload apache
+  notify: Reload apache
 
 - name: "Httpd-confd-vhosts: Incl virtual hosts in {{ apache_conf_path ~ '/httpd.conf' }}"
   ansible.builtin.lineinfile:
@@ -44,6 +44,6 @@
     insertbefore: BOF
     backup: "{{ apache_backup_conf }}"
   loop: "{{ al_include_confd_vars_list }}"
-  notify: reload apache
+  notify: Reload apache
 
 # EOF

tasks/httpd-dirs.yml

@@ -10,6 +10,6 @@
   loop: "{{ apache_directory_blocks }}"
   loop_control:
     label: "{{ item.Directory }}"
-  notify: reload apache
+  notify: Reload apache
 
 # EOF

tasks/httpd-modules.yml

@@ -1,3 +1,4 @@
+
 ---
 - name: "Httpd-modules: Load modules in {{ apache_conf_path ~ '/httpd.conf' }}"
   ansible.builtin.lineinfile:
@@ -7,7 +8,7 @@
     insertbefore: LoadModule
     backup: "{{ apache_backup_conf }}"
   loop: "{{ apache_httpd_conf_modules }}"
-  notify: restart apache
+  notify: Restart apache
   when: item.present | d(true)
 
 - name: "Httpd-modules: Unload modules in {{ apache_conf_path ~ '/httpd.conf' }}"
@@ -18,7 +19,7 @@
     insertbefore: LoadModule
     backup: "{{ apache_backup_conf }}"
   loop: "{{ apache_httpd_conf_modules }}"
-  notify: restart apache
+  notify: Restart apache
   when: not item.present | d(true)
 
 - name: "Httpd-modules: Config PHP in {{ apache_conf_path ~ '/Includes/php.conf' }}"
@@ -39,7 +40,7 @@
     mode: "0640"
     create: true
     backup: "{{ apache_backup_conf }}"
-  notify: restart apache
+  notify: Restart apache
   when: apache_php | bool
 
 # EOF

tasks/httpd-ssl.yml

@@ -13,7 +13,7 @@
         # line: "{{ item.regexp }} {{ item.line }}"
         backup: "{{ apache_backup_conf }}"
       loop: "{{ apache_httpd_conf_ssl_extra }}"
-      notify: reload apache
+      notify: Reload apache
 
     - name: "Httpd-ssl: Absent extra lines in {{ apache_conf_path ~ '/extra/httpd-ssl.conf' }}"
       ansible.builtin.lineinfile:
@@ -22,22 +22,22 @@
         regexp: "{{ item }}"
         backup: "{{ apache_backup_conf }}"
       loop: "{{ apache_httpd_conf_ssl_extra_absent }}"
-      notify: reload apache
+      notify: Reload apache
 
     - name: "Httpd-ssl: SSL Listen in {{ apache_conf_path ~ '/extra/httpd-ssl.conf' }}"
       ansible.builtin.lineinfile:
         dest: "{{ apache_conf_path }}/extra/httpd-ssl.conf"
         line: "{{ item }}"
         backup: "{{ apache_backup_conf }}"
       loop: "{{ apache_httpd_conf_ssl_listen }}"
-      notify: reload apache
+      notify: Reload apache
 
     - name: "Httpd-ssl: SSL in {{ apache_conf_path ~ '/httpd.conf' }}"
       ansible.builtin.lineinfile:
         dest: "{{ apache_conf_path }}/httpd.conf"
         line: "{{ item }}"
         backup: "{{ apache_backup_conf }}"
       loop: "{{ apache_httpd_conf_ssl }}"
-      notify: reload apache
+      notify: Reload apache
 
 # EOF

tasks/httpd-vhosts.yml

@@ -22,7 +22,7 @@
   loop: "{{ apache_vhost }}"
   loop_control:
     label: "{{ item.ServerName }}"
-  notify: reload apache
+  notify: Reload apache
 
 - name: "Httpd-vhosts: Incl virtual hosts in {{ apache_conf_path ~ '/httpd.conf' }}"
   ansible.builtin.lineinfile:
@@ -34,6 +34,6 @@
   loop: "{{ apache_vhost }}"
   loop_control:
     label: "{{ item.ServerName }}"
-  notify: reload apache
+  notify: Reload apache
 
 # EOF

tasks/httpd.yml

@@ -6,6 +6,6 @@
     line: "{{ item.regexp }} {{ item.line }}"
     backup: "{{ apache_backup_conf }}"
   loop: "{{ apache_httpd_conf }}"
-  notify: reload apache
+  notify: Reload apache
 
 # EOF

tasks/rcconf.yml

@@ -6,15 +6,15 @@
     line: '{{ item.key }}="{{ item.value }}"'
     backup: "{{ apache_backup_conf }}"
   loop: "{{ apache_rcconf }}"
-  notify: graceful apache
+  notify: Graceful apache
 
 - name: "Rc_conf: Enable and Start Apache"
   ansible.builtin.lineinfile:
     dest: /etc/rc.conf
     regexp: ^\s*{{ apache_service }}_enable\s*=(.*)$
     line: '{{ apache_service }}_enable="YES"'
     backup: "{{ apache_backup_conf }}"
-  notify: enable and start apache
+  notify: Enable and start apache
   when: apache_enable | bool
 
 - name: "Rc_conf: Disable and Stop Apache"
@@ -23,7 +23,7 @@
     regexp: ^\s*{{ apache_service }}_enable\s*=(.*)$
     line: '{{ apache_service }}_enable="NO"'
     backup: "{{ apache_backup_conf }}"
-  notify: disable and stop apache
+  notify: Disable and stop apache
   when: not apache_enable | bool
 
 # EOF