workflows.md

 1# Workflows
 2
 3This document provides an overview of different workflows that `git-bug`
 4supports.
 5
 6<!-- mdformat-start --slug=github --maxlevel=4 --minlevel=2 -->
 7
 8## Native workflow
 9
10<p align="center">
11    <img src="../assets/native-workflow.png" alt="Native workflow">
12</p>
13
14This is the pure `git-bug` experience. In a similar fashion as with code, use
15`git bug push` and `git bug pull` to push and pull your bugs between git remotes
16and collaborate with your teammate.
17
18_Recommended reading: [CLI documentation][docs/cli]_
19
20## Bridge workflow
21
22<p align="center">
23    <img src="../assets/bridge-workflow.png" alt="Bridge workflow">
24</p>
25
26`git-bug` supports syncing issues with third-party platforms, such as GitHub,
27GitLab, and Jira. This lets you work on issues offline, editing issues in bulk
28with your preferred editor, or to build an archive of any project's issues --
29it's up to you!
30
31_Recommended reading: [How to use bridges][docs/usage/bridges]_
32
33## Web UI workflow
34
35<p align="center">
36    <img src="../assets/webui-workflow.png" alt="Web UI workflow">
37</p>
38
39> [!NOTE]
40> The web UI is a work in progress, and is not feature-complete. To utilize
41> `git-bug` to its full potential, we recommend using the TUI or CLI.
42
43Often, projects needs to have their bug-tracker public and accept editions from
44anyone facing a problem. To support this workflow, `git-bug` aims to have the
45web UI accept external OAuth authentication and act as a public portal. However
46the web UI is not up to speed for that yet. Contributions are very much welcome!
47
48______________________________________________________________________
49
50##### See also<a name="see-also"></a>
51
52- [CLI documentation][docs/cli]
53- [Filtering query results][docs/usage/filter]
54- [How to use bridges][docs/usage/bridges]
55- [Learn about the native interfaces][docs/usage/interfaces]
56- :house: [Documentation home][docs/home]
57
58[docs/cli]: ../md/git-bug.md
59[docs/home]: ../README.md
60[docs/usage/bridges]: ./third-party.md
61[docs/usage/filter]: ./query-language.md
62[docs/usage/interfaces]: ./interfaces.md