diff options
| author | Michael Muré <batolettre@gmail.com> | 2022-05-31 20:20:25 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-31 20:20:25 +0200 |
| commit | 96327c3371ca762d906209c6114092bbf552c0f4 (patch) | |
| tree | cc236674c3ba003654e8708f24242a43c161644d | |
| parent | d94df634667146ff854c6da04c5f22bd513c3612 (diff) | |
| parent | 1c219f67698771ae3b0d1d08205263e5ba280a71 (diff) | |
| download | git-bug-96327c3371ca762d906209c6114092bbf552c0f4.tar.gz | |
Merge pull request #806 from MichaelMure/docs
doc: more discoverable docs
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | doc/README.md | 15 | ||||
| -rw-r--r-- | doc/model.md | 2 |
3 files changed, 23 insertions, 2 deletions
@@ -268,7 +268,11 @@ git bug bridge rm [<name>] ## Internals -Interested by how it works ? Have a look at the [data model](doc/model.md) and the [internal bird-view](doc/architecture.md). +Interested in how it works ? Have a look at the [data model](doc/model.md) and the [internal bird-view](doc/architecture.md). + +Or maybe you want to [make your own distributed data-structure in git](entity/dag/example_test.go) ? + +See also all the [docs](doc). ## Misc @@ -279,7 +283,7 @@ Interested by how it works ? Have a look at the [data model](doc/model.md) and t - media embedding - more bridges -- extendable data model to support arbitrary bug tracker +- webUI that can be used as a public portal to accept user's input - inflatable raptor ## Contribute diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..cf9fd845 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,15 @@ +# Documentation + +## For users + +- [data model](model.md) describe how the data model works and why. +- [query language](queries.md) describe git-bug's query language. +- [How-to: Read and edit offline your Github/Gitlab/Jira issues with git-bug](howto-github.md) + +## For developers + +- :exclamation: [data model](model.md) describe how the data model works and why. +- :exclamation: [internal bird-view](architecture.md) gives an overview of the project architecture. +- :exclamation: [Entity/DAG](../entity/dag/example_test.go) explain how to easily make your own distributed entity in git. +- [query language](queries.md) describe git-bug's query language. +- [JIRA bridge de v notes](jira_bridge.md)
\ No newline at end of file diff --git a/doc/model.md b/doc/model.md index de0de42a..0aad4789 100644 --- a/doc/model.md +++ b/doc/model.md @@ -3,6 +3,8 @@ Entities data model If you are not familiar with [git internals](https://git-scm.com/book/en/v1/Git-Internals), you might first want to read about them, as the `git-bug` data model is built on top of them. +In a different format, see how you can easily make your own [distributed data structure](../entity/dag/example_test.go). + ## Entities (bug, author, ...) are a series of edit operations As entities are stored and edited in multiple processes at the same time, it's not possible to store the current state like it would be done in a normal application. If two processes change the same entity and later try to merge the states, we wouldn't know which change takes precedence or how to merge those states. |