Switch to Zammad 6.1.

advanced/time-accounting.rst

@@ -1,23 +1,56 @@
 Time Accounting
 ===============
 
-Zammad supports detailed time accounting
-to help administrators keep track of how much time you spend
-on any given ticket, customer or client organization.
+Zammad supports detailed time accounting to help administrators keep track of
+how much time you spend on any given ticket, customer or client organization.
 
-.. figure:: /images/advanced/time-accounting.png
-   :alt: Time accounting dialog
+.. figure:: /images/advanced/time-accounting/time-accounting-simple-recording.png
+   :alt: Time Accounting Dialog
    :align: center
 
-   If time accounting is enabled,
-   this dialog will appear each time you update a ticket.
-   Enter how much time you spent on it
-   (in minutes, or whichever unit of time all your other colleagues are using).
+If the time accounting is enabled, this dialog will appear each time you update
+a ticket. Enter how much time you spent on it.
 
 .. note:: **🤔 Huh? I don’t see a “Time Accounting” dialog...** 
 
-   This feature is **optional**;
-   if you don’t see it whenever you update a ticket,
-   that means your administrator hasn’t enabled it yet.
+   This feature is **optional**; if you don’t see it whenever you update a
+   ticket, that means your administrator hasn’t enabled it yet.
    Administrators can learn more
-   `here <https://admin-docs.zammad.org/en/latest/manage-time-accounting.html>`_.
+   :admin-docs:`here <manage/time-accounting.html>`.
+
+.. hint:: **In which unit is the accounted time recorded?**
+
+   The Accounted time is always recorded as unitless numbers. However, your
+   administrator may decide to show an optional label next to the field to hint
+   you and your colleagues which unit is assumed.
+
+   .. figure:: /images/advanced/time-accounting/time-accounting-unit-recording.png
+      :alt: Time Accounting Unit
+      :align: center
+
+.. hint:: **What is an Activity Type?**
+
+   **Activity Types** are used for grouping accounted time entries together.
+   This is an **optional** feature which shows a list of activities as a
+   selectable list.
+
+   .. figure:: /images/advanced/time-accounting/time-accounting-select-activity-type.png
+      :alt: Time Accounting Activity Type
+      :align: center
+
+   Simply choose the closest type of the activity you are recording the time
+   for, noting that one of the choices may be pre-selected. You can always
+   remove the selection for general accounted time that is not supposed to be
+   grouped together.
+
+**Where can I see how much time has been accounted to this ticket?**
+
+If a ticket already has accounted time(s), you can see it in the ticket pane
+at the bottom. You can find the calculated sums of each activity type as well
+as the total sum of accounted times for all activity types.
+
+.. figure:: /images/advanced/time-accounting/ticket-pane-accounted-time.png
+   :alt: Screenshot showing accounted times in ticket pane
+   :align: center
+
+   Accounted times in the ticket view

basics/service-ticket.rst

@@ -11,4 +11,4 @@ Once you get the hang of the tasks below, there’s really not much more to it.
 
    service-ticket/create
    service-ticket/follow-up
-   Managing Ticket Settings <service-ticket/settings>
+   service-ticket/settings

conf.py

@@ -12,7 +12,11 @@
 source_suffix = '.rst'
 master_doc = 'index'
 exclude_patterns = ['_build', 'html', 'doctrees']
-extensions = ['versionwarning.extension', 'sphinx_tabs.tabs']
+extensions = [
+   'versionwarning.extension',
+   'sphinx_tabs.tabs',
+   'sphinx.ext.extlinks',
+]
 
 locale_dirs = ['locale/']
 gettext_compact = "user-docs"
@@ -95,3 +99,17 @@ def setup(app):
       "If you're a hosted user, please contact support."
    ),
 }
+
+# Provide aliases to common external documentation targets.
+#   It supports automatic substitution for the current language
+#   and branch placeholders.
+#
+#   :admin-docs:`the administrator documentation <manage/users/index.html>`
+#
+#   which renders the following link in English docs on pre-release branch:
+#
+#   https://admin-docs.zammad.org/en/pre-release/manage/users/index.html
+#
+extlinks = {
+   'admin-docs': (f'https://admin-docs.zammad.org/{language}/{branch}/%s', '')
+}

extras/profile-and-settings.rst

@@ -86,9 +86,15 @@ Profile Settings
 
    Upload an avatar.
 
-:Password:
+:Password & Auth:
 
-   Change your login password (may be disabled by system admin).
+   Change your login password and manage your two-factor authentication methods
+   (both may be disabled by system admin).
+
+   .. hint::
+      :doc:`Two-Factor Authentication </extras/two-factor-authentication>` is an
+      optional feature. Administrators can learn more
+      :admin-docs:`here <settings/security/two-factor.html>`.
 
 :Notifications:
 

extras/secure-email.rst

@@ -1,77 +1,101 @@
 Secure Email
 ============
 
-Zammad supports S/MIME for high-security email communication. 
+Zammad supports two systems of high-security email communication:
+   * Pretty Good Privacy (PGP) 
+   * Secure/Multipurpose Internet Mail Extensions (S/MIME).
 
 .. figure:: /images/extras/secure-email/creating-articles_signed-and-encrypted.gif
    :alt: Screencast demo of S/MIME features for both new tickets and replies
    :scale: 50%
    :align: center
 
-   Use the 🔒 **Encrypt** and ✅ **Sign** buttons to turn on encryption and signing for outgoing emails.
+   Use the 🔒 **Encrypt** and ✅ **Sign** buttons to turn on encryption and
+   signing of outgoing emails.
 
-.. note:: **🤔 Huh? I don’t see “Sign” or “Encrypt” options in the ticket view...** 
+.. note:: **🤔 Huh? I don't see “Sign” or “Encrypt” options in the ticket 
+   view...** 
 
    This feature is **optional**;
-   if you don’t see it in the ticket composer,
-   that means your administrator hasn’t enabled it yet.
-   Administrators can learn more
-   `here <https://admin-docs.zammad.org/en/latest/system/integrations/smime.html>`_.
+   if you don't see it in the ticket composer,
+   that means your administrator hasn't enabled it yet.
+   Administrators can learn more here:
 
-What is S/MIME?
----------------
+   * :admin-docs:`PGP </system/integrations/pgp/index.html>`
+   * :admin-docs:`S/MIME </system/integrations/smime/index.html>`
 
-S/MIME is the most widely-supported method for secure email communication.
-With S/MIME, you can exchange **signed** and **encrypted** messages with others.
+Overview
+--------
+
+PGP and S/MIME are the most widely-supported methods for secure email
+communication. With each of the systems, you can exchange **signed** and 
+**encrypted** messages with others.
 
 Signing
-   is proof that a message hasn’t been tampered with or sent by an impersonator.
+   is a proof that a message hasn't been manipulated on its way.
 
-   In other words, it guarantees a message’s **integrity** and **authenticity**.
+   In other words, it guarantees message **integrity** and **authenticity**.
 
 Encryption
-   scrambles a message so that it can only be unscrambled by the intended recipient.
+   scrambles a message so that it can only be unscrambled by the intended
+   recipient.
 
-   In other words, it guarantees **privacy** and **data security**.
+   In other words, it guarantees message **privacy** and **data security**.
 
-Overview
---------
+.. note:: 🤝 **PGP and S/MIME are only working if the other party is using them
+   too.**
+
+   Your administrator is responsible for adding all the necessary certificates
+   and keys in Zammad's admin panel.
+
+.. note:: In special cases it is possible that both systems are configured in
+   your system *and* a customer is using both, as well. In this case, you have
+   an additional button to switch between PGP and S/MIME security types.
+   Otherwise, you just see the 🔒 **Encrypt** and ✅ **Sign** buttons.
 
-.. note:: 🤝 **S/MIME only works if the other party is using it, too.**
+.. figure:: /images/extras/secure-email/pgp_and_smime.png
+   :alt: Screenshot of ticket creation with configured PGP and S/MIME 
+   :scale: 50%
+   :align: center
 
-   Your administrator is responsible for
-   adding all the necessary certificates in Zammad’s admin panel.
+   Ticket creation with configured PGP *and* S/MIME and available
+   certificates/keys.
 
 📬 Incoming
 ^^^^^^^^^^^
 
-The 🔒 and ✅ icons at the top of a message indicate its S/MIME status.
+The 🔒 and ✅ icons at the top of a message indicate its encryption and signing
+status.
 
 .. figure:: /images/extras/secure-email/checking-security-metadata.gif
-   :alt: Screencast showing on how to verify used certificates
+   :alt: Screencast showing details of encryption and signing status
    :scale: 50%
    :align: center
 
    Click on an incoming message to expand its details.
-   Hover over the security status to show a certificate/CA summary.
+   Hover over the security status to show more information.
 
 .. list-table:: Status Icons (Incoming)
    :widths: 5 45
 
    * - |lock|
      - This message was **encrypted for you**.
 
-       Even if it was intercepted by a third party (hacker, gov’t agency, etc.),
-       they won’t be able to read it.
-   * - |open-lock|
-     - This message is **not encrypted**.
+       Even if it was intercepted by a third party (hacker, gov't agency, etc.),
+       they won't be able to read it.
+
+   * - |encryption-error|
+     - This message can **not be decrypted**.
+
    * - |signed|
-     - This message’s signature has been **successfully verified**.
+     - This message's signature has been **successfully verified**.
+
+       You can be confident that it's authentic and that the content has not
+       been modified.
 
-       You can be confident that it’s authentic
-       and that the contents have not been modified.
    * - |not-signed|
-     - This message is **not signed**.
+     - The verification of the signature of this message has **failed**. You
+       can find more information by hovering over the icon.
 
 📮 Outgoing
 ^^^^^^^^^^^
@@ -82,28 +106,31 @@ to turn on encryption and signing for outgoing emails.
 .. note:: Outgoing emails can only be encrypted for *a single recipient*.
 
 .. figure:: /images/extras/secure-email/creating-articles_signed-and-encrypted.gif
-   :alt: Screencast demo of S/MIME features for both new tickets and replies
+   :alt: Screencast showing encryption and signing status for both new tickets and replies
    :scale: 50%
    :align: center
 
    🔒 **Encrypt** and ✅ **Sign** buttons are present on both new tickets and replies.
-   Hover over the buttons to show a certificate/CA summary.
+   Hover over the buttons to show details.
 
 .. list-table:: Status Icons (Outgoing)
    :widths: 5 45
 
    * - |lock|
      - This message **will be encrypted**.
 
-       Even if it’s intercepted by a third party (hacker, gov’t agency, etc.),
-       they won’t be able to read it.
+       Even if it's intercepted by a third party (hacker, gov't agency, etc.),
+       they won't be able to read it.
+
    * - |open-lock|
      - This message **will not be encrypted**.
+
    * - |signed|
      - This message **will be signed**.
 
-       Recipients using S/MIME can verify that it came from you
-       and that the contents have not been modified.
+       Recipients can verify that it came from you and that the content has
+       not been modified.
+
    * - |not-signed|
      - This message **will not be signed**.
 
@@ -120,6 +147,9 @@ to turn on encryption and signing for outgoing emails.
 .. |not-signed| image:: /images/extras/secure-email/icon_not-signed.png
    :width: 24px
    :height: 24px
+.. |encryption-error| image:: /images/extras/secure-email/icon_encryption-error.png
+   :width: 24px
+   :height: 24px
 
 Troubleshooting
 ---------------
@@ -132,14 +162,14 @@ Troubleshooting
       :alt: Ticket article shows a warning for failed verification of a signed message
       :align: center
 
-   Without the sender’s certificate, Zammad cannot verify the message signature.
+   Without the sender's certificate, Zammad cannot verify the message signature.
 
-   Ask your administrator to add the sender’s certificate to Zammad’s certificate store.
+   Ask your administrator to add the sender's certificate to Zammad's certificate store.
 
    .. warning:: 🕵️ **ALWAYS verify certificates in-person or over the phone!**
 
       The whole point of signature verification is to alert you
-      when someone is trying to pretend to be someone they’re not.
+      when someone is trying to pretend to be someone they're not.
       Never accept a certificate from someone online without verifying it first.
 
 “Encryption: Unable to find private key to decrypt”
@@ -150,19 +180,19 @@ Troubleshooting
    This message was encrypted with a certificate that does not match any on file.
    Without a matching private key, Zammad cannot decrypt the message.
 
-   Ask your administrator to verify your organization’s private key in Zammad’s certificate store,
+   Ask your administrator to verify your organization's private key in Zammad's certificate store,
    and ask the sender to double-check the public key they used to encrypt the message.
 
    .. hint:: 📢 **Your public key can be safely shared with anyone.**
 
-      (But if they’re smart, they’ll take extra precautions
+      (But if they're smart, they'll take extra precautions
       to make sure it really belongs to you.)
 
 📮 Outgoing
 ^^^^^^^^^^^
 
 The 🔒 **Encrypt** button is disabled
-   Ask your administrator to add the recipient’s certificate to Zammad’s certificate store.
+   Ask your administrator to add the recipient's certificate to Zammad's certificate store.
 
 The ✅ **Sign** button is disabled
-   Ask your administrator to verify your organization’s private key in Zammad’s certificate store.
+   Ask your administrator to verify your organization's private key in Zammad's certificate store.