Skip to content

Commit

Permalink
Maintenance: Create/consolidate aliases for all documentation parts f…
Browse files Browse the repository at this point in the history
…or better linking.
  • Loading branch information
dvuckovic committed Sep 22, 2023
1 parent 89dec4d commit 1fddc6d
Show file tree
Hide file tree
Showing 22 changed files with 509 additions and 575 deletions.
3 changes: 2 additions & 1 deletion .rstcheck.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ report_level=WARNING
ignore_directives =
tabs
ignore_roles=
admin-docs
admin-docs,
docs
4 changes: 2 additions & 2 deletions advanced/macros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ macros can make the job a whole lot easier.

.. note:: 🤔 **How do I make macros?**

You don’t – that’s the `administrator’s job
<https://admin-docs.zammad.org/en/latest/manage/macros.html>`_.
You don’t – that’s the
:admin-docs:`administrator’s job </manage/macros.html>`.
If you have an idea for a macro you’d like to use,
your Zammad admin can probably make it happen.

Expand Down
6 changes: 2 additions & 4 deletions advanced/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,8 @@ Available attributes

.. hint::

For a more detailed list of available attributes please take a look into our
`Zammad Admin-Documentation
<https://docs.zammad.org/en/latest/install/elasticsearch/indexed-attributes.html>`_

For a more detailed list of available attributes please take a look into our
:docs:`Zammad System Documentation </install/elasticsearch/indexed-attributes.html>`.

.. |br| raw:: html

Expand Down
2 changes: 1 addition & 1 deletion advanced/text-modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Customizing text modules
^^^^^^^^^^^^^^^^^^^^^^^^

Administrators can learn more about customizing text modules
`here <https://admin-docs.zammad.org/en/latest/manage-text-modules.html>`_.
:admin-docs:`here </manage/text-modules.html>`.
6 changes: 2 additions & 4 deletions advanced/ticket-templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ The configured ticket fields will be populated with the data from the template.
Managing templates requires additional permissions.
Please ask your administrator to provide you with the needed permission.

`Learn more about ticket templates in the admin documentation`_.
Learn more about ticket templates
:admin-docs:`in the admin documentation </manage/templates.html>`.

This permission was introduced with Zammad 5.3.

.. These version notes will be removed on later documentation versions.
.. _Learn more about ticket templates in the admin documentation:
https://admin-docs.zammad.org/en/latest/manage/templates.html
2 changes: 1 addition & 1 deletion advanced/time-accounting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ a ticket. Enter how much time you spent on it.
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
:admin-docs:`here <manage/time-accounting.html>`.
:admin-docs:`here </manage/time-accounting.html>`.

.. hint:: **In which unit is the accounted time recorded?**

Expand Down
10 changes: 4 additions & 6 deletions basics/find-ticket/browse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,16 @@ Looking for a ticket to work on? Check the **overviews** menu.
for the tickets it displays.

There are **six built-in overviews**
(Zammad admin may `create more`_ with custom-defined filters):
(Zammad admin may :admin-docs:`create more </manage/overviews.html>` with
custom-defined filters):

* **My assigned tickets** (*open/pending* only)
* **Unassigned & Open**
* **My pending reached tickets** (previously marked *pending* and currently due)
* **Open** (system-wide)
* **Pending reached** (system-wide, previously marked *pending* and currently due)
* **Escalated** (system-wide, failing to meet a `service-level agreement`_)

.. _create more: https://admin-docs.zammad.org/en/latest/manage/overviews.html
.. _service-level agreement:
https://admin-docs.zammad.org/en/latest/manage/slas/index.html
* **Escalated** (system-wide, failing to meet a
:admin-docs:`service-level agreement </manage/slas/index.html>`)

.. tip:: **🖱️ UI Protip**

Expand Down
6 changes: 2 additions & 4 deletions basics/service-ticket/follow-up.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,8 @@ quotations by using enter.
.. note:: **🧐 Huh? I can't see escalation timestamps!**

SLAs are optional and require configuration by your instance administrator.
Administrators can learn more `about SLAs in our admin documentation`_.

.. _about SLAs in our admin documentation:
https://admin-docs.zammad.org/en/latest/manage/slas/index.html
Administrators can learn more about SLAs
:admin-docs:`in our admin documentation </manage/slas/index.html>`.

On the top of every ticket being applicable for SLA escalations, you'll find
two dates next to the ticket number. By hovering the escalation date, Zammad
Expand Down
3 changes: 2 additions & 1 deletion basics/service-ticket/settings/group.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ then they’d only ever see the tickets that belong to their own group.

.. note:: **So how do I manage which team I’m on?**

You don’t – that’s the `administrator’s job <https://admin-docs.zammad.org/en/latest/manage-groups.html>`_.
You don't – that's the
:admin-docs:`administrator's job </manage/groups/index.html>`.

However, you can *check* which teams you’re on
in the Notifications section of
Expand Down
19 changes: 6 additions & 13 deletions basics/service-ticket/settings/priority.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,12 @@ Out of the box, **ticket priority doesn’t actually do anything**.
However, Zammad administrators can set up all sorts of automated hooks
that fire off based on this value, like:

* `service-level agreements`_,
* `triggers`_, and
* `scheduled events`_.

Priority can also be used as a ticket filter when creating `custom overviews`_.

.. _service-level agreements:
https://admin-docs.zammad.org/en/latest/manage/slas/index.html
.. _triggers: https://admin-docs.zammad.org/en/latest/manage/trigger.html
.. _scheduled events:
https://admin-docs.zammad.org/en/latest/manage/scheduler.html
.. _custom overviews:
https://admin-docs.zammad.org/en/latest/manage/overviews.html
* :admin-docs:`service-level agreements </manage/slas/index.html>`,
* :admin-docs:`triggers </manage/trigger.html>`, and
* :admin-docs:`scheduled events </manage/scheduler.html>`.

Priority can also be used as a ticket filter when creating
:admin-docs:`custom overviews </manage/overviews.html>`.

In other words, **consult your administrator**
for details on how he’d like you to use it.
11 changes: 5 additions & 6 deletions basics/service-ticket/settings/state.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,11 @@ the ticket much faster in general – without having a look into details.
What’s the difference between “new” and “open”?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

States do more than just indicate progress:
Zammad has a fine-grained time tracking feature
(so-called “\ `service-level agreements <https://admin-docs.zammad.org/en/latest/manage-slas.html>`_\ ”, or SLAs)
that uses state information to measure how long it takes
for customers to get a response on a new ticket
or get their issues resolved entirely.
States do more than just indicate progress: Zammad has a fine-grained time
tracking feature (so-called
:admin-docs:`service-level agreements </manage/slas/index.html>`”,
or SLAs) that uses state information to measure how long it takes for customers
to get a response on a new ticket or get their issues resolved entirely.

On a *new* ticket,
the customer still hasn’t received her first response on the issue.
Expand Down

0 comments on commit 1fddc6d

Please sign in to comment.