Fixes #511 - Unified header structure across the repo

Author: ralf401

about/zammad.rst

@@ -1,12 +1,15 @@
 Zammad
-******
+======
 
 Do you receive many emails and want to answer them with a team of agents?
 
 You're going to love Zammad_!
 
-Zammad is a web based open source helpdesk/customer support system with many features to manage customer communication via several channels like telephone, facebook, twitter, chat and emails.
-It is distributed under version 3 of the GNU AFFERO General Public License (GNU AGPLv3).
+Zammad is a web based open source helpdesk/customer support system with many
+features to manage customer communication via several channels like telephone,
+facebook, twitter, chat and emails.
+It is distributed under version 3 of the GNU AFFERO General Public License
+(GNU AGPLv3).
 
 The code is open source, and `available on GitHub`_!
 

admin/console.rst

@@ -1,5 +1,5 @@
 Console
-*******
+=======
 
 Zammad uses Ruby on Rails so you can make use of the `rails console`_.
 
@@ -14,11 +14,11 @@ Zammad uses Ruby on Rails so you can make use of the `rails console`_.
 
 To open the rails console on the shell you have to enter the following commands.
 
-Start Zammad's Rails console
-============================
+Start Zammad's Rails Console
+----------------------------
 
-Running a single command
-------------------------
+Running a Single Command
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 The following command will allow you to run a single command, without running
 a shell (e.g. for automation).
@@ -41,8 +41,8 @@ a shell (e.g. for automation).
 
 .. _rails_shell:
 
-Running several commands in a shell
------------------------------------
+Running Several Commands in a Shell
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The following command will provide you a rails console.
 It allows you to run several commands inside it.
@@ -87,7 +87,7 @@ This reduces loading times greatly.
          3.1.3 :001 >
 
 Working on the console
-======================
+----------------------
 
 Here's a topic list for quick jumping and better overview.
 

admin/console/dangerzone-for-experts.rst

@@ -1,5 +1,5 @@
-Deleting records
-****************
+Deleting Records
+================
 
 .. danger::
 
@@ -9,7 +9,7 @@ Deleting records
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Removing tickets (and their articles)
+Removing Tickets (And Their Articles)
 -------------------------------------
 
 .. code-block:: ruby
@@ -24,7 +24,7 @@ Removing tickets (and their articles)
    >> tickets_to_keep = [1, 2, 3]
    >> Ticket.where.not(id: tickets_to_keep).destroy_all
 
-Removing users
+Removing Users
 --------------
 
 .. warning::
@@ -62,7 +62,7 @@ Removing users is possible in 2 ways: A single user and in bulk.
                email: ['<email address 1>', '<email address 2>']
             ).destroy_all
 
-Removing organizations
+Removing Organizations
 ----------------------
 
 .. note:: Removing an organization does **not** delete associated customers.
@@ -99,7 +99,7 @@ Step 3: Proceed with deletion
            org.destroy
          end
 
-Removing system records
+Removing System Records
 -----------------------
 
 .. code-block:: ruby
@@ -120,10 +120,10 @@ Removing system records
 
 .. _dangerzone_reset_zammad:
 
-Reset Zammad installation
+Reset Zammad Installation
 -------------------------
 
-.. hint:: 
+.. hint::
 
    Below commands are incomplete intentionally, error outputs will hint you
    through! The following operations will cause data loss and are for

admin/console/hidden-settings.rst

@@ -1,12 +1,12 @@
-Advanced customization settings
-*******************************
+Advanced Customization Settings
+===============================
 
 On this page you can find some settings that you won't find within the Zammad
 UI. Those settings might come in handy as it can change Zammad's behavior.
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Send all outgoing E-Mails to a BCC-Mailbox
+Send All Outgoing E-Mails to a BCC-Mailbox
 ------------------------------------------
 
 This option allows you to send all outgoing E-Mails (not notifications) to a
@@ -23,7 +23,7 @@ You can easily check the current BCC-Setting by running the following:
 
    >> Setting.get('system_bcc')
 
-Activate counter on grouped overviews
+Activate Counter on Grouped Overviews
 -------------------------------------
 
 This is a hidden setting which you can only set via Command-Line.
@@ -38,7 +38,7 @@ elements.
 
 .. image:: /images/console/ui_table_group_by_show_count-example.png
 
-Default ticket type on creation
+Default Ticket Type on Creation
 -------------------------------
 
 Zammad allows you to define the default article type upon ticket creation.
@@ -60,7 +60,7 @@ To check what setting is set currently, simply run:
 
    >> Setting.get('ui_ticket_create_default_type')
 
-Adding a warning to the ticket creation process
+Adding a Warning to the Ticket Creation Process
 -----------------------------------------------
 
 If in case you need to give your agent a note or warning during ticket creation,
@@ -97,7 +97,7 @@ Sample of the above setting:
 
 .. image:: /images/console/ui_ticket_create_notes.gif
 
-Adding a warning to the article reply process
+Adding a Warning to the Article Reply Process
 ---------------------------------------------
 
 In case you need to give your agent a warning during the ticket article reply,
@@ -140,7 +140,7 @@ Sample of the above setting:
 
 .. image:: /images/console/ui_ticket_add_article_hint-example.gif
 
-Show Email address of customer on customer selection (ticket creation)
+Show Email Address of Customer on Customer Selection (Ticket Creation)
 ----------------------------------------------------------------------
 
 By default Zammad will not display the E-Mail-Addresses of customers.
@@ -156,8 +156,8 @@ Get the current state of this setting with:
 
    >> Setting.get('ui_user_organization_selector_with_email')
 
-Change font settings for outgoing HTML mails
---------------------------------------------
+Change Font Settings for Outgoing HTML Emails
+---------------------------------------------
 
 .. note::
 
@@ -177,7 +177,7 @@ If you want to check the current setting, you can simply run the below code.
 
    >> Setting.get('html_email_css_font')
 
-Highlight customer's open ticket count
+Highlight Customer's Open Ticket Count
 --------------------------------------
 
 This option enhances the selected customer's open tickets count. It highlights

admin/console/other-useful-commands.rst

@@ -1,10 +1,10 @@
 Other Useful Commands
-*********************
+=====================
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Fetch Mails
------------
+Fetch Emails
+------------
 
 The below command will do a manual fetch of mail channels.
 This will also show errors that might appear within that process.
@@ -85,7 +85,7 @@ for several languages.
 .. _Weblate: https://translations.zammad.org/
 
 Translating Attributes
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
 
 By default Zammad will not translate custom attributes.
 With the following code you can enable translation.

admin/console/working-on-chat.rst

@@ -1,9 +1,9 @@
 Working with chat logs
-**********************
+======================
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Removing IP address logs
+Removing IP Address Logs
 ------------------------
 
 Use the following command to remove all IP address records

admin/console/working-on-groups.rst

@@ -1,9 +1,9 @@
 Working with groups
-*******************
+===================
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Find group
+Find Group
 ----------
 
 .. code-block:: ruby

admin/console/working-on-ticket-articles.rst

@@ -1,9 +1,9 @@
-Working with ticket articles
-****************************
+Working with Ticket Articles
+============================
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Count Public “Notes” toward SLAs
+Count Public “Notes” Toward SLAs
 --------------------------------
 
 Normally, :user-docs:`notes </basics/service-ticket/follow-up.html#adding-new-messages-notes>`

admin/console/working-on-tickets.rst

@@ -1,10 +1,10 @@
-Working with ticket information
-*******************************
+Working with Ticket Information
+===============================
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Get the RAW mail that Zammad fetched
-------------------------------------
+Get the RAW Email That Zammad Fetched
+-------------------------------------
 
 The following command will help you to check on received EML-files Zammad
 fetched. This comes in handy if you delete Mails upon fetching and you need to
@@ -33,7 +33,7 @@ we get, we can then get the articles content.
    If you just use ``Ticket::Article.find(3)`` you can see further information
    (like who sent the mail, when we fetched it, ...).
 
-Update all tickets of a specific customer
+Update All Tickets of a Specific Customer
 -----------------------------------------
 
 .. warning::
@@ -47,7 +47,7 @@ Update all tickets of a specific customer
 
 .. _state_types:
 
-Get ticket state types
+Get Ticket State Types
 ----------------------
 .. Not removed because it is still referenced in API state creation.
 

admin/console/working-on-users.rst

@@ -1,9 +1,9 @@
-Working on user information
-***************************
+Working on User Information
+===========================
 
 .. include:: /admin/console/missing-commands-ask-community.include.rst
 
-Find user
+Find User
 ---------
 
 In order to work on user information or to check for specific information,
@@ -15,7 +15,7 @@ you'll need to find it first.
    >> User.find_by(email: 'your@email')  # Searching for the user by his Email address
    >> User.find_by(login: 'john.doe')    # Searching for the user by his login
 
-Unlock a locked user account
+Unlock a Locked User Account
 ----------------------------
 
 .. tip::
@@ -45,7 +45,7 @@ logins)
 
    >> User.find(**USERID**).login_failed
 
-Change / Update Email address of user
+Change / Update Email Address of User
 -------------------------------------
 
 If needed, you can simply change the Email address of the user.
@@ -64,7 +64,7 @@ If needed, you can simply change the Email address of the user.
 
 You need to find the user ID of the user first for this.
 
-Change / Update Login name of user
+Change / Update Login Name of User
 ----------------------------------
 
 Change the user name of the user (e.g. if you want to login with a shorter
@@ -79,7 +79,7 @@ username instead of a mail address)
 
 You need to find the user ID of the user first for this.
 
-Set admin rights for user
+Set Admin Rights for User
 -------------------------
 
 Don't have access to Zammad anymore? Grant yourself or another user
@@ -91,7 +91,7 @@ administrative rights.
    >> u.roles = Role.where(name: ['Agent', 'Admin'])
    >> u.save!
 
-Set password for user
+Set Password for User
 ---------------------
 
 You or the user did forget his password? No problem! Simply reset it by hand
@@ -100,8 +100,8 @@ if needed.
 .. code-block:: ruby
 
    >> User.find_by(email: '[email protected]').update!(password: 'your_new_password')
-   
-Remove password for user
+
+Remove Password for User
 ------------------------
 
 If you added a second authentication method (e.g. LDAP) after launch, there