Merge pull request #110 from zammad/pre-release

Zammad 5.4

README.md

@@ -9,24 +9,42 @@ Source files for [Zammad’s user documentation][docs].
 If you would like to improve the docs, simply:
 
 1. fork the repo,
-2. edit the appropriate `.rst` files (see [Markup Format](#markup-format) below),
-   and
+2. edit the appropriate `.rst` files
+   (see [Markup Format](#restructuredtext-markup) below), and
 3. submit a pull request.
 
 > 🌍 **Wanna help translate?** Submit your contributions
 > (or request additional languages) [here][wbetranslate].
 > Do **NOT** submit a PR with changes to the contents of the `locale/` directory.
 
 Thanks! ❤ ❤ ❤  
-The Zammad Team
+   The Zammad Team
 
-### Markup Format
+### ReStructuredText Markup
 
-These docs are written using the ReStructuredText markup format. Info about
-this markup language can be found at:
+If you like to edit the docs use the ReStructuredText markup language.
+Information about this markup language can be found at:
 
-- <http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>
-- <https://sphinx-rtd-theme.readthedocs.io/en/latest/demo/structure.html>
+- http://www.sphinx-doc.org/en/stable/rest.html
+- http://docs.readthedocs.io/en/latest/_themes/sphinx_rtd_theme/demo_docs/source/demo.html
+
+### Versioning
+
+This documentation provides versions:
+
+- ``pre-release`` can contain develop, not yet released functions and changes
+- ``main`` is the ``latest`` (and stable) version of the repository
+- ``stable-x.x`` is the old back port for an earlier version
+  - These branches do not receive further updates and serve as historic help
+    for administrators
+
+## Notes on Documentation Branches and Pull Requests
+
+Please note that this repository uses protected branches.
+The most current version is **always**  ``pre-release`` - if you create
+Pull Requests, please use ``pre-release`` as destination Branch.
+
+This will ensure that your changes are available upon merge.
 
 ## Compilation
 
@@ -44,13 +62,12 @@ this markup language can be found at:
   $ brew install gettext              # macOS
   $ sudo apt install gettext          # Debian / Ubuntu
   $ sudo dnf install gettext          # Fedora
-  ...
   ```
 
-### Local HTML build
+### Example for a local HTML build
 
 ```
-$ make html
+make html
 ```
 
 ### Localization using Weblate
@@ -63,6 +80,8 @@ Weblate will automatically provide the translation parts in in its UI for
 all available languages. If there's translation progress it will automatically
 provide pull requests on this repository. 🎉
 
+Pull requests containing direct translations within the PO files will be denied.
+
 ```
 # ensure clean enviroment
 $ make clean
@@ -75,7 +94,10 @@ $ make -e SPHINXOPTS="-D language='de'" html
 $ make -e SPHINXOPTS="-D language='en'" html
 ```
 
-### Localization process
+If you have a problem with creating / building the documentation,
+please create an issue. Thanks.
+
+### Localization progress
 
 [![Translation progress][tprogress]][wbetranslate]
 

basics/service-ticket/settings.rst

@@ -48,6 +48,8 @@ text. (Your highlights are visible to other agents.)
 
 ----
 
+.. _ticket-submenu:
+
 .. tip:: **🖱️ UI Protip**
 
    Additional actions are available via the **submenu**:

basics/service-ticket/settings/state.rst

@@ -7,6 +7,10 @@ and may be one of the following:
 * new
 * open
 * closed
+* merged
+  (this Ticket has been merged into another Ticket. Check either the
+  :doc:`linked tickets </advanced/ticket-actions/link>` or the
+  :ref:`ticket history <ticket-submenu>` to learn more)
 * pending close
   (*i.e.,* scheduled to automatically close at a later date)
 * pending reminder

conf.py

@@ -59,6 +59,8 @@ def setup(app):
    # If we're **not on latest**, we'll display a deprecation warning.
    if version == 'latest':
       branch = version
+   elif version == 'pre-release':
+      branch = "pre-release"
    else:
       branch = "old-version"