Fixes #84 - Rework API-Documentation (#207)

* Rework API Intro

* Closes #81 - Add Encoding information

* Add attribute warning for Core Workflows

* Add: General sort and order hint for searches

This allows us to remove the hints for said functionality on search parts all over the documentation.

* Maintenance: Raise maximum pre-size for H-U-G-E payload samples

* Maintenance: Fix intend

* Rework user endpoint

* Rework organizations endpoint

* Maintenance: Rework API group endpoint

* Maintenance: Improve wording & provide full payloads for ticket endpoints

Also slightly enhances affected console documentation parts to reduce confusions and provide richer context.

* Maintenance: Rework ticket article API documentation

* Maintenance: Rework online notification API documentation

* Cherry-Pick: SLA endpoints

* Add rest api documentation for calendars endpoint. (#206)

* Add rest api documentation for calendars endpoint.

* Maintenance: Add further notes / hints

Co-authored-by: Marcel Herrguth <github@thehomeofanime.de>

* Maintenance: Rework API Access token

* Maintenance: Rework object API

* Merge pull request #202 from zammad/mh/introduce/core-workflow-pending-till

Fixes #201 - Remove obsolete pending till; Add Core Workflows hints

* Maintenance: Consistently point out for order and sorting options on searches

* Maintenance: Remove issue notes (fixed in stable)

* Maintenance: Readd accidently removed label

* Maintenance: Normalize place holder style

* Maintenance: Improve article creation calls into tabs for better overview

Co-authored-by: Rolf Schmidt <rolf.schmidt@znuny.com>

_static/theme/theme_overrides.css

@@ -17,7 +17,7 @@
 }
 
 .collapsing-code-block--open {
-    max-height: 5000px;
+    max-height: 15000px;
     transition: all 0.5s ease-in;
     box-shadow: none;
     -webkit-box-shadow: none;

admin/console/working-on-tickets.rst

@@ -48,23 +48,46 @@ The following commands will enable you to change the naming of priorities. If yo
    >> priority2.default_create = true
    >> priority2.save!
 
+.. _state_types:
 
 Get ticket state types
 ----------------------
 
-This will show all Ticket States needed for creating new states.
 
-.. note:: Missing States you just created? You might want to use ``Ticket.State.all``  to display all states for Tickets.
+This will show all state types needed for creating new ticket states.
+
+.. tip:: **😖 What are state types?**
+
+   Zammad uses state types to know what it should do with your state.
+   This allows you to have different types like *pending actions*,
+   *pending reminders* or *closed* states.
+
+   State types also indicate the color scheme to be used.
+   You can learn more about that `in our user documentation`_.
+
+.. _in our user documentation:
+   https://user-docs.zammad.org/en/latest/basics/service-ticket/settings/state.html
 
 .. code-block:: ruby
 
-   >> Ticket::StateType.all
+   >> Ticket::StateType.pluck(:id, :name)
+
+Above will return both, the type ID and name - e.g.:
+``[[1, "new"], [2, "open"], ...``.
 
 
 Add new ticket state
 --------------------
 
-.. note:: You can use ``ignore_escalation: true,`` to ignore possible SLA escalations (pending reminder and pending close use that by default).
+   .. note:: **🤓 Missing States you just created?**
+
+      You might want to use ``Ticket.State.pluck(:id, :name)``
+      to get a listing of all available ticket states.
+
+   .. tip:: **🙈 ignoring escalations**
+
+      You can use ``ignore_escalation: true,`` to ignore possible SLA
+      calculations (pending reminder and pending close do this by default).
 
 Non-Pending states
 ^^^^^^^^^^^^^^^^^^
@@ -131,6 +154,8 @@ Replace ``pending customer feedback`` with the pending state of your choice.
          updated_by_id:      1,
       )
 
+.. _states_to_ui:
+
 Make new states available to UI
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

api/calendar.rst

@@ -603,14 +603,6 @@ Required permission: ``admin.calendar``
    is not possible via API - this will be indicated by
    ``"error": "Can't delete, object has references."``. This is *not* a bug.
 
-      .. note::
-
-         Due to `Issue 3845`_ above statement currently is invalid.
-         Right now Zammad just removes said configuration and thus may
-         break SLAs.
-
-.. _Issue 3845: https://github.com/zammad/zammad/issues/3845
-
 ``DELETE``-Request sent: ``/api/v1/calendars/{id}``
 
 .. code-block:: json