Skip to content

Commit

Permalink
Merge pull request #45 from zammad/mh/release/issue-trackers
Browse files Browse the repository at this point in the history
Add Issue Trackers page for GitHub and GitLab functionality
  • Loading branch information
MrGeneration committed Apr 13, 2021
2 parents 1306c0e + 0bdf00f commit 4645ec0
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 0 deletions.
51 changes: 51 additions & 0 deletions extras/github-gitlab-integration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
GitHub / GitLab Integration
===========================

With issue tracker integration,
you can monitor GitHub / GitLab issues right from within a Zammad ticket.

.. note:: 🤔 **Huh? I don’t see** |github| **or** |gitlab| **tabs...**

This feature is **optional**; if you don’t see it in the ticket pane,
that means your administrator hasn’t enabled it yet.
Administrators can learn more
`here <https://admin-docs.zammad.org/en/latest/system/integrations.html#integrations-for-issue-trackers>`_.

.. figure:: /images/extras/issue-trackers/ticket-settings-with-github-issues.png
:alt: Ticket detail view showing activated GitHub & GitLab function
:align: center

Use the |github| and |gitlab| tabs on the ticket pane
for an overview of issues related to the ticket.

What can it do?
---------------

View related issues
Use the |github| and |gitlab| tabs on the ticket pane to see linked issues,
along with metadata like status (open/closed), assignee, labels, and more.
Or, simply click the title to view the issue on GitHub / GitLab.

A badge on the tab icon indicates how many issues are linked to this ticket.

Link a new issue
At the top of the ticket pane, select **GitHub / GitLab > Link Issue**,
then enter a valid issue URL.

.. note:: ⌛ **Linking a new issue can be slow sometimes.**

.. figure:: /images/extras/issue-trackers/list-and-add-new-issues-to-ticket.gif
:alt: Screencast showing how to list and add new issues to a ticket
:width: 90%
:align: center

Remove an issue
Click the ✕ button next to an issue title to unlink it.

.. |github| image:: /images/icons/github-64px.png
:alt: GitHub logo
:width: 16px

.. |gitlab| image:: /images/icons/gitlab-64px.png
:alt: GitLub logo
:width: 16px
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icons/github-64px.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icons/gitlab-64px.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,4 @@ Zammad Agent Documentation
/extras/profile-and-settings
/extras/knowledge-base
/extras/i-doit-track-company-property
/extras/github-gitlab-integration

0 comments on commit 4645ec0

Please sign in to comment.