Improve ticket system docs #556
Conversation
|
Kudos, SonarCloud Quality Gate passed!
|
Codecov Report
@@ Coverage Diff @@
## master #556 +/- ##
=======================================
Coverage 80.62% 80.62%
=======================================
Files 73 73
Lines 3504 3504
=======================================
Hits 2825 2825
Misses 679 679 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| Altering the link to a ticket | ||
| ============================= | ||
|
|
||
| There are two ways to add the link: |
There was a problem hiding this comment.
A bit unclear here: Why is altering mentioned and next it says add?
| ``/api/v2/incidents/{incident_pk}/automatic-ticket/}`` will use the configured | ||
| ticket system plugin to create a ticket in the configured ticket system. The | ||
| resulting new URL is then automatically stored on the incident. To edit, | ||
| replace or remove this link, the endpoints in the previous section must be |
There was a problem hiding this comment.
| replace or remove this link, the endpoints in the previous section must be | |
| replace or remove this link, the endpoints from the previous section must be |
But that's just personal preference, not a must
| To enable this feature information needs to be added to the | ||
| :ref:`site-specific-settings`. How to do that for each ticket system plugin is | ||
| detailed in :ref:`ticket-systems-settings`. |
There was a problem hiding this comment.
It's actually not detailed there anymore, since we outsourced that to the separate plugins
| .. toctree:: | ||
| ticket-systems/settings | ||
| ticket-systems/writing-ticket-system-plugins |
There was a problem hiding this comment.
This feels weird at the end of the page. We either should put it at the top or just link to it within the text.
Missing: a list of the finished plugins we already know of.