Fixes #716 - Fix/align names and wording

Author: ralf401

admin/console.rst

@@ -1,7 +1,7 @@
 Console
 =======
 
-Zammad uses Ruby on Rails so you can make use of the `rails console`_.
+Zammad uses Ruby on Rails so you can make use of the `Rails console`_.
 
 .. _rails console:
    http://guides.rubyonrails.org/command_line.html
@@ -12,7 +12,7 @@ Zammad uses Ruby on Rails so you can make use of the `rails console`_.
    might cause data loss or damaged tickets! If you're unsure,
    **use a test system first**!
 
-To open the rails console on the shell you have to enter the following commands.
+To open the Rails console on the shell you have to enter the following commands.
 
 Start Zammad's Rails Console
 ----------------------------
@@ -56,7 +56,7 @@ a shell (e.g. for automation).
 Running Several Commands in a Shell
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The following command will provide you a rails console.
+The following command will provide you a Rails console.
 It allows you to run several commands inside it.
 
 .. tabs::
@@ -85,16 +85,16 @@ It allows you to run several commands inside it.
 
 .. hint:: **Starting Rails Console in Safe Mode**
 
-   Normally, starting rails console requires certain
-   :doc:`third-party services </prerequisites/software>` to be up and running.
+   Normally, starting a Rails console requires certain
+   :doc:`third party services </prerequisites/software>` to be up and running.
    You may receive errors and console will refuse to start in case they are not
    available.
 
-   However, it's possible to start rails console in safe mode by setting
+   However, it's possible to start Rails console in safe mode by setting
    the environment variable ``ZAMMAD_SAFE_MODE=1``. With this setting enabled,
    the availability of these services will be ignored.
 
-   **Set variable and run rails console:**
+   **Set variable and run Rails console:**
 
    .. tabs::
 
@@ -116,7 +116,7 @@ It allows you to run several commands inside it.
    .. code-block:: text
       :class: no-copybutton
 
-      Zammad is running in safe mode. Any third-party services like Redis are ignored.
+      Zammad is running in safe mode. Any third party services like Redis are ignored.
 
       There was an error trying to connect to Redis via redis://localhost:6379.
       Please provide a Redis instance at localhost:6379 or set REDIS_URL to point to a different location.

admin/console/zammad-settings.rst

@@ -127,19 +127,19 @@ Configuring Elasticsearch
 If your Elasticsearch installation changes, you can use the following commands
 to ensure that Zammad still can access Elasticsearch.
 
-Change elasticsearch URL:
+Change Elasticsearch URL:
 
 .. code-block:: irb
 
    >> Setting.set('es_url', 'http://127.0.0.1:9200')
 
-Set elasticsearch user (e.g. for authentication):
+Set Elasticsearch user (e.g. for authentication):
 
 .. code-block::
 
    >> Setting.set('es_user', 'elasticsearch')
 
-Set the password for authentication of the elasticsearch user:
+Set the password for authentication of the Elasticsearch user:
 
 .. code-block:: irb
 
@@ -157,7 +157,7 @@ Set ignored file extensions / file types (they will not be indexed):
 
    >> Setting.set('es_attachment_ignore', %w[.png .jpg .jpeg .mpeg .mpg .mov .bin .exe .box .mbox])
 
-Set the maximum attachment to be indexed by elasticsearch:
+Set the maximum attachment to be indexed by Elasticsearch:
 
 .. code-block:: irb
 

api/intro.rst

@@ -15,15 +15,15 @@ Please note that these clients may not provide access to all available
 endpoints listed here.
 
    * `Ruby Client <https://github.com/zammad/zammad-api-client-ruby>`_
-     *(Official)*
+     *(official)*
    * `PHP Client <https://github.com/zammad/zammad-api-client-php>`_
-     *(Official)*
-   * `Python Client <https://pypi.org/project/zammad-py/>`_ *(Third-Party)*
-   * `.NET Client <https://github.com/Asesjix/Zammad-Client>`_ *(Third-Party)*
+     *(official)*
+   * `Python Client <https://pypi.org/project/zammad-py/>`_ *(third party)*
+   * `.NET Client <https://github.com/Asesjix/Zammad-Client>`_ *(third party)*
    * `Android API-Client <https://github.com/KirkBushman/zammad-android>`_
-     *(Third-Party)*
+     *(third party)*
    * `Go Client <https://github.com/AlessandroSechi/zammad-go>`_
-     *(Third-Party; API client only, no "ready to use" App)*
+     *(third party; API client only, no "ready to use" app)*
 
 Authentication
 --------------

api/object.rst

@@ -8,7 +8,7 @@ Object
    fields.
 
    If you want to hide fields, consider :admin-docs:`Core Workflows </system/core-workflows.html>`
-   instead. For states and priorities use either API endpoints or rails console.
+   instead. For states and priorities use either API endpoints or Rails console.
 
 List
 ----

api/ticket/articles.rst

@@ -67,9 +67,9 @@ type
       requests via twitter.
 
    ``facebook feed post`` & ``facebook feed comment``
-      These articles types are used by Zammads facebook channel.
+      These articles types are used by Zammads Facebook channel.
       Technically you can use these to automatically respond to existing
-      requests via facebook.
+      requests via Facebook.
 
    ``telegram personal-message``
       Used by Zammads Telegram channel.

api/ticket/states.rst

@@ -173,7 +173,7 @@ Required permission: ``admin.object``
    specific set of IDs. State types indicate how the state will work.
 
    As there's no endpoint for retreiving these,
-   please use the :ref:`rails console <state_types>`.
+   please use the :ref:`Rails console <state_types>`.
 
 ``POST``-Request sent: ``/api/v1/ticket_states``
 

appendix/backup-and-restore/console-command-note.include.rst

@@ -2,7 +2,7 @@
 
 .. note::
 
-   Keep in mind that docker-compose and source code installations do not know
+   Keep in mind that Docker Compose and source code installations do not know
    ``zammad run``. Below commands show the package installation way, just remove
    all ``zammad run`` parts from the commands and run them.
 

appendix/backup-and-restore/docker-compose.rst

@@ -6,10 +6,10 @@ Backup & Restore (Docker)
 
    docker-file-handling
 
-This section shows some basics about the backup and restore process for a docker
-compose based deployment of Zammad.
+This section shows some basics about the backup and restore process for a Docker
+Compose based deployment of Zammad.
 
-If you are familiar with volume based backup and restore procedures in docker,
+If you are familiar with volume based backup and restore procedures in Docker,
 and perhaps already use a different method or tool, then you can keep using it.
 A backup would typically mean shutting down the stack to ensure all in-memory
 files get written to disk, then backing up the volume contents, and then starting
@@ -18,12 +18,12 @@ using the :ref:`disable-backup-service scenario <additional-scenarios>` so that
 the built-in backup and restore mechanism of Zammad is not activated.
 
 The rest of this page describes the built-in backup and restore mechanism of
-Zammad's docker compose stack.
+Zammad's Docker Compose stack.
 
-If you're familiar with docker, the sections below include the
+If you're familiar with Docker, the sections below include the
 information you'll need. The
 :doc:`/appendix/backup-and-restore/docker-file-handling` page covers some
-examples about how to handle the backup files and to copy it into a docker
+examples about how to handle the backup files and to copy it into a Docker
 volume to restore it.
 
 Backup
@@ -45,7 +45,7 @@ Restore
 #. Copy or move the backup files to ``/var/tmp/zammad/restore/`` inside the
    volume of the **zammad-backup** container. Be aware that the restore process
    always uses the latest backup according to the timestamp of the file name.
-   Only backups from package and docker installations are supported by this
+   Only backups from package and Docker installations are supported by this
    built-in backup method. Don't provide the ``latest_zammad_*.gz`` files
    because they link to an unknown location for the restore process.
 #. Start the stack. The restore process is triggered if the ``restore``

appendix/backup-and-restore/docker-file-handling.rst

@@ -2,7 +2,7 @@ File Handling Examples
 ======================
 
 If you're not sure how to handle the backup files and how to create the
-``restore`` directory in the docker volume, you can find some examples below.
+``restore`` directory in the Docker volume, you can find some examples below.
 
 Restore Inside the Same Stack
 -----------------------------
@@ -25,7 +25,7 @@ Restore from Another Installation
 
 **Requires:** console access to the host system and the zammad-backup container.
 
-To **obtain** your backup files from another docker compose deployment, one way
+To **obtain** your backup files from another Docker Compose deployment, one way
 is to copy it to the host system with ``docker compose cp``:
 
 .. code-block:: console

appendix/configure-database-server.rst

@@ -62,7 +62,7 @@ Adjust ``max_connections`` (mandatory)
 
          $ sed -i "/max_connections/c\max_connections = 2000" <postgresql-configuration-file>
 
-      Apply changes by restarting postgresql and Zammad (in this order):
+      Apply changes by restarting PostgreSQL and Zammad (in this order):
 
       .. code-block:: console
 
@@ -92,7 +92,7 @@ Adjust PostgreSQL for bigger instances (optional)
 
       $ sed -i "/max_stack_depth/c\max_stack_depth = 5MB" <postgresql-configuration-file>
 
-   Apply changes by restarting postgresql and Zammad (in this order):
+   Apply changes by restarting PostgreSQL and Zammad (in this order):
 
    .. code-block:: console