MichaelMure/git-bug
1
1
Fork 0
mirror of https://github.com/MichaelMure/git-bug.git synced 2024-12-14 08:45:30 +03:00
Code Issues Projects Releases Wiki Activity

doc: more discoverable docs

Browse Source
This commit is contained in:
Michael Muré 2022-05-31 20:16:22 +02:00
parent d94df63466
commit 1c219f6769
3 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -268,7 +268,11 @@ git bug bridge rm [<name>]
## Internals ## 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 ## Misc
@ -279,7 +283,7 @@ Interested by how it works ? Have a look at the [data model](doc/model.md) and t
- media embedding - media embedding
- more bridges - 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 - inflatable raptor
## Contribute ## Contribute

15
doc/README.md Normal file
View File

@ -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)

2
doc/model.md
View File

@ -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. 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 ## 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. 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.