Merge pull request #3685 from luixxiul/fix

spantaleev · web-flow · commit d1c7f7eef192 · 2024-10-27T22:25:19.000+02:00
Fix more capitalizations on documentation
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1757,7 +1757,7 @@ You could then restart services: `ansible-playbook -i inventory/hosts setup.yml
 
 # 2022-04-25
 
-## buscarron bot support
+## Buscarron bot support
 
 Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [the Buscarron bot](https://github.com/etkecc/buscarron). It's a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room
 
diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ Bots provide various additional functionality to your installation.
 | [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) | x | Bot for scheduling one-off & recurring reminders and alarms | [Link](docs/configuring-playbook-bot-matrix-reminder-bot.md) |
 | [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) | x | Bot for invitations by creating and managing registration tokens | [Link](docs/configuring-playbook-bot-matrix-registration-bot.md) |
 | [maubot](https://github.com/maubot/maubot) | x | A plugin-based Matrix bot system | [Link](docs/configuring-playbook-bot-maubot.md) |
-| [honoroit](https://github.com/etkecc/honoroit) | x | A helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) |
+| [Honoroit](https://github.com/etkecc/honoroit) | x | A helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) |
 | [Postmoogle](https://github.com/etkecc/postmoogle) | x | Email to Matrix bot | [Link](docs/configuring-playbook-bot-postmoogle.md) |
 | [Go-NEB](https://github.com/matrix-org/go-neb) | x | A multi functional bot written in Go | [Link](docs/configuring-playbook-bot-go-neb.md) |
 | [Mjolnir](https://github.com/matrix-org/mjolnir) | x | A moderation tool for Matrix | [Link](docs/configuring-playbook-bot-mjolnir.md) |
diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md
@@ -79,7 +79,7 @@ The `schildichat.example.com` subdomain may be necessary, because this playbook
 
 The `wsproxy.example.com` subdomain may be necessary, because this playbook could install the [wsproxy](https://github.com/mautrix/wsproxy) web client. The installation of wsproxy is disabled by default, it is not a core required component. To learn how to install it, see our [configuring wsproxy guide](configuring-playbook-bridge-mautrix-wsproxy.md). If you do not wish to set up wsproxy, feel free to skip the `wsproxy.example.com` DNS record.
 
-The `buscarron.example.com` subdomain may be necessary, because this playbook could install the [buscarron](https://github.com/etkecc/buscarron) bot. The installation of buscarron is disabled by default, it is not a core required component. To learn how to install it, see our [configuring buscarron guide](configuring-playbook-bot-buscarron.md). If you do not wish to set up buscarron, feel free to skip the `buscarron.example.com` DNS record.
+The `buscarron.example.com` subdomain may be necessary, because this playbook could install the [Buscarron](https://github.com/etkecc/buscarron) bot. The installation of Buscarron is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Buscarron guide](configuring-playbook-bot-buscarron.md). If you do not wish to set up Buscarron, feel free to skip the `buscarron.example.com` DNS record.
 
 The `rageshake.example.com` subdomain may be necessary, because this playbook could install the [rageshake](https://github.com/matrix-org/rageshake) bug report server. The installation of rageshake is disabled by default, it is not a core required component. To learn how to install it, see our [configuring rageshake guide](configuring-playbook-rageshake.md). If you do not wish to set up rageshake, feel free to skip the `rageshake.example.com` DNS record.
 
diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md
@@ -1,6 +1,6 @@
 # Setting up Buscarron (optional)
 
-The playbook can install and configure [buscarron](https://github.com/etkecc/buscarron) for you.
+The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you.
 
 Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room.
 
diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md
@@ -1,6 +1,6 @@
 # Setting up Cinny (optional)
 
-This playbook can install the [cinny](https://github.com/ajbura/cinny) Matrix web client for you.
+This playbook can install the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you.
 
 Cinny is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of Element.
 
diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md
@@ -200,7 +200,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins
 
 - [Setting up maubot](configuring-playbook-bot-maubot.md) - a plugin-based Matrix bot system (optional)
 
-- [Setting up honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional)
+- [Setting up Honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional)
 
 - [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) - an extensible multifunctional bot (optional)
 
diff --git a/docs/container-images.md b/docs/container-images.md
@@ -1,4 +1,4 @@
-# Container Images used by the playbook
+# Container images used by the playbook
 
 This page summarizes the container ([Docker](https://www.docker.com/)) images used by the playbook when setting up your server.
 
@@ -100,7 +100,7 @@ These services are not part of our default installation, but can be enabled by [
 
 - [dock.mau.dev/maubot/maubot](https://mau.dev/maubot/maubot/container_registry) - the [maubot](https://github.com/maubot/maubot) bot (a plugin-based Matrix bot system) (optional)
 
-- [etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) - the [honoroit](https://github.com/etkecc/honoroit) helpdesk bot (optional)
+- [etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) - the [Honoroit](https://github.com/etkecc/honoroit) helpdesk bot (optional)
 
 - [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) - the [Postmoogle](https://github.com/etkecc/postmoogle) email bridge bot (optional)
 
diff --git a/roles/custom/matrix-base/defaults/main.yml b/roles/custom/matrix-base/defaults/main.yml
@@ -80,7 +80,7 @@ matrix_server_fqn_cinny: "cinny.{{ matrix_domain }}"
 # This is where you access the SchildiChat web client from (if enabled via matrix_client_schildichat_enabled; disabled by default).
 matrix_server_fqn_schildichat: "schildichat.{{ matrix_domain }}"
 
-# This is where you access the buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default).
+# This is where you access the Buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default).
 matrix_server_fqn_buscarron: "buscarron.{{ matrix_domain }}"
 
 # This is where you access the Dimension.
diff --git a/roles/custom/matrix-bot-buscarron/defaults/main.yml b/roles/custom/matrix-bot-buscarron/defaults/main.yml
@@ -1,6 +1,6 @@
 ---
 
-# buscarron is a Web forms (HTTP POST) to Matrix service.
+# Buscarron is a Web forms (HTTP POST) to Matrix service.
 # Project source code URL: https://github.com/etkecc/buscarron
 
 matrix_bot_buscarron_enabled: true
@@ -186,7 +186,7 @@ matrix_bot_buscarron_smtp_from: ''
 # enforce SMTP validation
 matrix_bot_buscarron_smtp_validation: false
 
-# Additional environment variables to pass to the buscarron container
+# Additional environment variables to pass to the Buscarron container
 #
 # Example:
 # matrix_bot_buscarron_environment_variables_extension: |
diff --git a/roles/custom/matrix-bot-buscarron/tasks/setup_install.yml b/roles/custom/matrix-bot-buscarron/tasks/setup_install.yml
@@ -26,7 +26,7 @@
         - ansible.builtin.set_fact:
             matrix_bot_buscarron_requires_restart: true
 
-- name: Ensure buscarron paths exist
+- name: Ensure Buscarron paths exist
   ansible.builtin.file:
     path: "{{ item.path }}"
     state: directory
@@ -40,7 +40,7 @@
     - {path: "{{ matrix_bot_buscarron_docker_src_files_path }}", when: true}
   when: "item.when | bool"
 
-- name: Ensure buscarron support files installed
+- name: Ensure Buscarron support files installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/{{ item }}.j2"
     dest: "{{ matrix_bot_buscarron_config_path }}/{{ item }}"
@@ -51,7 +51,7 @@
     - env
     - labels
 
-- name: Ensure buscarron image is pulled
+- name: Ensure Buscarron image is pulled
   community.docker.docker_image:
     name: "{{ matrix_bot_buscarron_docker_image }}"
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
@@ -63,7 +63,7 @@
   delay: "{{ devture_playbook_help_container_retries_delay }}"
   until: result is not failed
 
-- name: Ensure buscarron repository is present on self-build
+- name: Ensure Buscarron repository is present on self-build
   ansible.builtin.git:
     repo: "{{ matrix_bot_buscarron_docker_repo }}"
     version: "{{ matrix_bot_buscarron_docker_repo_version }}"
@@ -74,7 +74,7 @@
   register: matrix_bot_buscarron_git_pull_results
   when: "matrix_bot_buscarron_container_image_self_build | bool"
 
-- name: Ensure buscarron image is built
+- name: Ensure Buscarron image is built
   community.docker.docker_image:
     name: "{{ matrix_bot_buscarron_docker_image }}"
     source: build
@@ -92,7 +92,7 @@
     dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-buscarron.service"
     mode: 0644
 
-- name: Ensure buscarron container network is created
+- name: Ensure Buscarron container network is created
   community.general.docker_network:
     enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
     name: "{{ matrix_bot_buscarron_container_network }}"
diff --git a/roles/custom/matrix-bot-buscarron/tasks/setup_uninstall.yml b/roles/custom/matrix-bot-buscarron/tasks/setup_uninstall.yml
@@ -19,7 +19,7 @@
         path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-buscarron.service"
         state: absent
 
-    - name: Ensure Matrix buscarron paths don't exist
+    - name: Ensure Matrix Buscarron paths don't exist
       ansible.builtin.file:
         path: "{{ matrix_bot_buscarron_base_path }}"
         state: absent
diff --git a/roles/custom/matrix-bot-honoroit/defaults/main.yml b/roles/custom/matrix-bot-honoroit/defaults/main.yml
@@ -1,17 +1,17 @@
 ---
-# honoroit is a helpdesk bot
+# Honoroit is a helpdesk bot
 # Project source code URL: https://github.com/etkecc/honoroit
 
 matrix_bot_honoroit_enabled: true
 
-# The hostname at which honoroit is served.
+# The hostname at which Honoroit is served.
 matrix_bot_honoroit_hostname: ''
 
-# The path at which honoroit is exposed.
+# The path at which Honoroit is exposed.
 # This value must either be `/` or not end with a slash (e.g. `/honoroit`).
 matrix_bot_honoroit_path_prefix: /
 
-# The path at which honoroit will expose metrics
+# The path at which Honoroit will expose metrics
 # This value must either be `/` or not end with a slash (e.g. `/metrics`).
 matrix_bot_honoroit_metrics_path: /metrics
 
@@ -161,7 +161,7 @@ matrix_bot_honoroit_redmine_new_status_id: ''  # new status ID (e.g. 1)
 matrix_bot_honoroit_redmine_in_progress_status_id: ''  # in progress status ID (e.g. 2)
 matrix_bot_honoroit_redmine_done_status_id: ''  # done status ID (e.g. 3)
 
-# A list of whitelisted users allowed to use/invite honoroit
+# A list of whitelisted users allowed to use/invite a Honoroit bot
 # If not defined, everyone is allowed.
 # Example set of rules:
 # matrix_bot_honoroit_allowedusers:
diff --git a/roles/custom/matrix-bot-honoroit/tasks/setup_install.yml b/roles/custom/matrix-bot-honoroit/tasks/setup_install.yml
@@ -26,7 +26,7 @@
         - ansible.builtin.set_fact:
             matrix_bot_honoroit_requires_restart: true
 
-- name: Ensure honoroit paths exist
+- name: Ensure Honoroit paths exist
   ansible.builtin.file:
     path: "{{ item.path }}"
     state: directory
@@ -40,7 +40,7 @@
     - {path: "{{ matrix_bot_honoroit_docker_src_files_path }}", when: true}
   when: "item.when | bool"
 
-- name: Ensure honoroit support files installed
+- name: Ensure Honoroit support files installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/{{ item }}.j2"
     dest: "{{ matrix_bot_honoroit_config_path }}/{{ item }}"
@@ -51,7 +51,7 @@
     - env
     - labels
 
-- name: Ensure honoroit image is pulled
+- name: Ensure Honoroit image is pulled
   community.docker.docker_image:
     name: "{{ matrix_bot_honoroit_docker_image }}"
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
@@ -63,7 +63,7 @@
   delay: "{{ devture_playbook_help_container_retries_delay }}"
   until: result is not failed
 
-- name: Ensure honoroit repository is present on self-build
+- name: Ensure Honoroit repository is present on self-build
   ansible.builtin.git:
     repo: "{{ matrix_bot_honoroit_docker_repo }}"
     version: "{{ matrix_bot_honoroit_docker_repo_version }}"
@@ -74,7 +74,7 @@
   register: matrix_bot_honoroit_git_pull_results
   when: "matrix_bot_honoroit_container_image_self_build | bool"
 
-- name: Ensure honoroit image is built
+- name: Ensure Honoroit image is built
   community.docker.docker_image:
     name: "{{ matrix_bot_honoroit_docker_image }}"
     source: build
@@ -86,7 +86,7 @@
       pull: true
   when: "matrix_bot_honoroit_container_image_self_build | bool"
 
-- name: Ensure honoroit container network is created
+- name: Ensure Honoroit container network is created
   community.general.docker_network:
     enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
     name: "{{ matrix_bot_honoroit_container_network }}"
diff --git a/roles/custom/matrix-bot-honoroit/tasks/setup_uninstall.yml b/roles/custom/matrix-bot-honoroit/tasks/setup_uninstall.yml
@@ -19,7 +19,7 @@
         path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-honoroit.service"
         state: absent
 
-    - name: Ensure Matrix honoroit paths don't exist
+    - name: Ensure Matrix Honoroit paths don't exist
       ansible.builtin.file:
         path: "{{ matrix_bot_honoroit_base_path }}"
         state: absent
diff --git a/roles/custom/matrix-bot-honoroit/tasks/validate_config.yml b/roles/custom/matrix-bot-honoroit/tasks/validate_config.yml
@@ -1,6 +1,6 @@
 ---
 
-- name: Fail if required honoroit settings not defined
+- name: Fail if required Honoroit settings not defined
   ansible.builtin.fail:
     msg: >-
       You need to define a required configuration setting (`{{ item.name }}`).
diff --git a/roles/custom/matrix-bridge-heisenbridge/defaults/main.yml b/roles/custom/matrix-bridge-heisenbridge/defaults/main.yml
@@ -1,5 +1,5 @@
 ---
-# heisenbridge is a bouncer-style Matrix IRC bridge
+# Heisenbridge is a bouncer-style Matrix IRC bridge
 # Project source code URL: https://github.com/hifi/heisenbridge
 
 matrix_heisenbridge_enabled: true
@@ -93,7 +93,7 @@ matrix_heisenbridge_registration_yaml_heisenbridge:
   displayname: "{{ matrix_heisenbridge_config_displayname }}"
 
 # Default registration file consumed by both the homeserver and Heisenbridge.
-# Besides registration information, it contains configuration (see the heisenbridge key).
+# Besides registration information, it contains configuration (see the Heisenbridge key).
 matrix_heisenbridge_registration_yaml:
   id: heisenbridge
   url: http://matrix-heisenbridge:9898
diff --git a/roles/custom/matrix-bridge-heisenbridge/tasks/setup_install.yml b/roles/custom/matrix-bridge-heisenbridge/tasks/setup_install.yml
@@ -1,6 +1,6 @@
 ---
 
-- name: Ensure heisenbridge image is pulled
+- name: Ensure Heisenbridge image is pulled
   community.docker.docker_image:
     name: "{{ matrix_heisenbridge_docker_image }}"
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
@@ -11,7 +11,7 @@
   delay: "{{ devture_playbook_help_container_retries_delay }}"
   until: result is not failed
 
-- name: Ensure heisenbridge paths exist
+- name: Ensure Heisenbridge paths exist
   ansible.builtin.file:
     path: "{{ item }}"
     state: directory
@@ -21,15 +21,15 @@
   with_items:
     - "{{ matrix_heisenbridge_base_path }}"
 
-- name: Ensure heisenbridge registration.yaml installed if provided
+- name: Ensure Heisenbridge registration.yaml installed if provided
   ansible.builtin.copy:
     content: "{{ matrix_heisenbridge_registration | to_nice_yaml(indent=2, width=999999) }}"
     dest: "{{ matrix_heisenbridge_base_path }}/registration.yaml"
     mode: 0644
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_user_groupname }}"
 
-- name: Ensure heisenbridge support files installed
+- name: Ensure Heisenbridge support files installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/{{ item }}.j2"
     dest: "{{ matrix_heisenbridge_base_path }}/{{ item }}"
@@ -39,7 +39,7 @@
   with_items:
     - labels
 
-- name: Ensure heisenbridge container network is created
+- name: Ensure Heisenbridge container network is created
   community.general.docker_network:
     enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
     name: "{{ matrix_heisenbridge_container_network }}"
diff --git a/roles/custom/matrix-bridge-heisenbridge/tasks/validate_config.yml b/roles/custom/matrix-bridge-heisenbridge/tasks/validate_config.yml
@@ -1,6 +1,6 @@
 ---
 
-- name: Fail if required heisenbridge settings not defined
+- name: Fail if required Heisenbridge settings not defined
   ansible.builtin.fail:
     msg: >-
       You need to define a required configuration setting (`{{ item.name }}`).
