diff options
| -rw-r--r-- | README.md | 51 | ||||
| -rw-r--r-- | doc/architecture.md | 4 | ||||
| -rw-r--r-- | doc/feature_matrix.md | 124 |
3 files changed, 148 insertions, 31 deletions
@@ -25,8 +25,6 @@ - **integrates with your tooling**: use the UI you like (CLI, terminal, web) or integrate with your existing tools through the CLI or the GraphQL API - **bridges to other bug trackers**: use [bridges](#bridges) to import and export to other trackers. -:construction: This is now more than a proof of concept, but still not fully stable. Expect dragons and unfinished business. :construction: - ## Help needed! This project has grown bigger than I can handle by myself, especially with a day job. I'm looking for people to help on or maintain part of it: @@ -182,7 +180,7 @@ An interactive terminal UI is available using the command `git bug termui` to br  -## Web UI (status: WIP) +## Web UI You can launch a rich Web UI with `git bug webui`. @@ -200,34 +198,28 @@ The web UI interact with the backend through a GraphQL API. The schema is availa ## Bridges +β
: working π : partial implementation β: not working + ### Importer implementations -| | Github | Gitlab | Jira | Launchpad | -|-------------------------------------------------|:------------------:|:------------------:|:------------------:|:------------------:| -| **incremental**<br/>(can import more than once) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| **with resume**<br/>(download only new data) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| **identities** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| identities update | :x: | :x: | :x: | :x: | -| **bug** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| comments | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| comment editions | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: | -| labels | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| status | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| title edition | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| **media/files** | :x: | :x: | :x: | :x: | -| **automated test suite** | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | +| | Github | Gitlab | Jira | Launchpad | +|-------------------------------------------------|:------:|:------:|:----:|:---------:| +| **incremental**<br/>(can import more than once) | β
| β
| β
| β | +| **with resume**<br/>(download only new data) | β
| β
| β
| β | +| **identities** | π | π | π | π | +| **bugs** | β
| β
| β
| π | +| **board** | β | β | β | β | +| **media/files** | β | β | β | β | +| **automated test suite** | β
| β
| β | β | ### Exporter implementations -| | Github | Gitlab | Jira | Launchpad | -|--------------------------|:------------------:|:------------------:|:------------------:|:---------:| -| **bug** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| comments | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| comment editions | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| labels | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| status | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| title edition | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| **automated test suite** | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | +| | Github | Gitlab | Jira | Launchpad | +|--------------------------|:------:|:------:|:----:|:---------:| +| **identities** | π | π | π | π | +| **bug** | β
| β
| β
| β | +| **board** | β | β | β | β | +| **automated test suite** | β
| β
| β | β | #### Bridge usage @@ -281,14 +273,15 @@ See also all the [docs](doc). ## Planned features -- media embedding -- more bridges +The [feature matrix](doc/feature_matrix.md) gives a good overview of what is planned, without being exhaustive. + +Additional planned feature: - webUI that can be used as a public portal to accept user's input - inflatable raptor ## Contribute -PRs accepted. Drop by the [Gitter lobby](https://gitter.im/the-git-bug/Lobby) for a chat or browse the issues to see what is worked on or discussed. +PRs accepted. Drop by the [Gitter lobby](https://gitter.im/the-git-bug/Lobby) or the [Matrix room](https://matrix.to/#/#the-git-bug_Lobby:gitter.im) for a chat, look at the [feature matrix](doc/feature_matrix.md) or browse the issues to see what is worked on or discussed. ```shell git clone git@github.com:MichaelMure/git-bug.git diff --git a/doc/architecture.md b/doc/architecture.md index 5f81462b..395886ea 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -88,7 +88,7 @@ The package `termui` contains the interactive terminal user interface, implement ## graphql -The package `graphql` implement the GraphQL API, mapping the data model and providing read/write access from outside of the process. This API is in particular used by the webUI but could be used to implement other user interfaces or bridges with other systems. +The package `graphql` implement the GraphQL API, mapping the data model and providing read/write access from outside the process. This API is in particular used by the webUI but could be used to implement other user interfaces or bridges with other systems. ## webui @@ -96,7 +96,7 @@ The package `webui` hold the web based user interface, implemented in both go an The javascript code is compiled and packaged inside the go binary, allowing for a single file distribution of git-bug. -When the webUI is started from the CLI command, a localhost HTTP server is started to serve the webUI resources (html, js, css), as well as the GraphQL API. When the webUI is loaded in the browser, it interact with the git-bug process through the GraphQL API to load and edit bugs. +When the webUI is started from the CLI command, a localhost HTTP server is started to serve the webUI resources (html, js, css), as well as the GraphQL API. When the webUI is loaded in the browser, it interacts with the git-bug process through the GraphQL API to load and edit bugs. ## bridge diff --git a/doc/feature_matrix.md b/doc/feature_matrix.md new file mode 100644 index 00000000..91abfba2 --- /dev/null +++ b/doc/feature_matrix.md @@ -0,0 +1,124 @@ +# User facing capabilities + +This document tries to give an overview of what is currently supported, and by extension where effort can be focused to bring feature completion and parity. + +As git-bug is a free software project, accept and rely on contributor, those feature matrices kinda define a roadmap, in the sense than anything mentioned below is a planned feature and can be worked on. This does not mean that a feature not mentioned here should not be considered, just maybe check the issue tracker and come talk about it. + +This document however does not show all the untold work required to support those user-facing capabilities. There has been a ton of work behind the scene and more will be required over time. + +β
: working π : partial implementation β: not working + +## Entities + +The most high level overview of what kind of entities are supported and where. + +| | Core | CLI | TermUI | WebUI | +|--------------|:----:|:---:|:------:|:-----:| +| Identities | β
| β
| β
| β
| +| Bug | β
| β
| β
| β
| +| Board | π | π | β | β | +| Pull-request | β | β | β | β | + +More specific features across the board. + +| | Core | CLI | TermUI | WebUI | +|--------------------|:----:|:---:|:------:|:-----:| +| Media embedding | π | β | β | β | +| Fast indexing | β
| β
| β
| β
| +| Markdown rendering | N/A | β | β | β
| + +#### Identities + +| | Core | CLI | TermUI | WebUI | +|-------------------------|:----:|:---:|:------:|:-----:| +| Public keys | π | β | β | β | +| Private keys management | π | β | β | β | +| Identity edition | β
| β
| β | β | +| Identity adoption | β
| β
| β | β | +| Identity protection | π | β | β | β | + +#### Bugs + +| | Core | CLI | TermUI | WebUI | +|-------------------|:----:|:---:|:------:|:-----:| +| Comments | β
| β
| β
| β
| +| Comments edition | β
| β
| β
| β
| +| Comments deletion | β
| β | β | β | +| Labels | β
| β
| β
| β
| +| Status | β
| β
| β
| β
| +| Title edition | β
| β
| β
| β
| +| Assignee | β | β | β | β | +| Milestone | β | β | β | β | + + +## Bridges + +### Importers + +General capabilities of importers: + +| | Github | Gitlab | Jira | Launchpad | +|-------------------------------------------------|:------:|:------:|:----:|:---------:| +| **incremental**<br/>(can import more than once) | β
| β
| β
| β | +| **with resume**<br/>(download only new data) | β
| β
| β
| β | +| **media/files** | β | β | β | β | +| **automated test suite** | β
| β
| β | β | + +Identity support: + +| | Github | Gitlab | Jira | Launchpad | +|-------------------|:------:|:------:|:----:|:---------:| +| **identities** | β
| β
| β
| β
| +| identities update | β | β | β | β | +| public keys | β | β | β | β | + +Bug support: + +| | Github | Gitlab | Jira | Launchpad | +|------------------|:------:|:------:|:----:|:---------:| +| **bug** | β
| β
| β
| β
| +| comments | β
| β
| β
| β
| +| comment editions | β
| β | β
| β | +| labels | β
| β
| β
| β | +| status | β
| β
| β
| β | +| title edition | β
| β
| β
| β | +| Assignee | β | β | β | β | +| Milestone | β | β | β | β | + +Board support: + +| | Github | Gitlab | Jira | Launchpad | +|-----------|:------:|:------:|:----:|:---------:| +| **board** | β | β | β | β | + +### Exporters + +**General capabilities of exporters**: + +| | Github | Gitlab | Jira | +|-------------------------------------------------|:------:|:------:|:----:| +| **incremental**<br/>(can export more than once) | β
| β
| β
| +| **with resume**<br/>(upload only new data) | β
| β
| β
| +| **automated test suite** | β
| β
| β | + +**Identity support**: + +| | Github | Gitlab | Jira | +|-------------------|:------:|:------:|:----:| +| **identities** | β
| β
| β
| +| identities update | β | β | β | + +Note: as the target bug tracker require accounts and credentials, there is only so much that an exporter can do about identities. A bridge should be able to load and use credentials for multiple remote account, but when they are not available, the corresponding changes can't be replicated. + +**Bug support**: + +| | Github | Gitlab | Jira | +|------------------|:------:|:------:|:----:| +| **bugs** | β
| β
| β
| +| comments | β
| β
| β
| +| comment editions | β
| β
| β
| +| labels | β
| β
| β
| +| status | β
| β
| β
| +| title edition | β
| β
| β
| +| Assignee | β | β | β | +| Milestone | β | β | β | |