diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-11-22 10:33:47 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-11-22 10:33:47 +0000 |
commit | acaa6d733b37b18eb44a5d6e3b79f69ee821f62a (patch) | |
tree | e9442322a4e1b09feac247b11504f601ecd0f9d1 | |
parent | 372209901514368d2053b3abd1a996ebb3e52b3c (diff) | |
parent | e887e96893f43a3a00429a1688c321ed131e5076 (diff) | |
download | gitlab-ce-acaa6d733b37b18eb44a5d6e3b79f69ee821f62a.tar.gz |
Merge branch 'object-state-models-docs' into 'master'
Object state models docs
Object state models docs for issues and merge requests.
This is to start documenting object models, focused more on users and how they experience the product.
See merge request !7544
-rw-r--r-- | doc/development/README.md | 1 | ||||
-rw-r--r-- | doc/development/img/state-model-issue.png | bin | 0 -> 13256 bytes | |||
-rw-r--r-- | doc/development/img/state-model-legend.png | bin | 0 -> 12412 bytes | |||
-rw-r--r-- | doc/development/img/state-model-merge-request.png | bin | 0 -> 22484 bytes | |||
-rw-r--r-- | doc/development/object_state_models.md | 25 |
5 files changed, 26 insertions, 0 deletions
diff --git a/doc/development/README.md b/doc/development/README.md index 371bb55c127..6f2ca7b8590 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -38,6 +38,7 @@ - [Rake tasks](rake_tasks.md) for development - [Shell commands](shell_commands.md) in the GitLab codebase - [Sidekiq debugging](sidekiq_debugging.md) +- [Object state models](object_state_models.md) ## Databases diff --git a/doc/development/img/state-model-issue.png b/doc/development/img/state-model-issue.png Binary files differnew file mode 100644 index 00000000000..c85fffc2a3a --- /dev/null +++ b/doc/development/img/state-model-issue.png diff --git a/doc/development/img/state-model-legend.png b/doc/development/img/state-model-legend.png Binary files differnew file mode 100644 index 00000000000..088230bfc39 --- /dev/null +++ b/doc/development/img/state-model-legend.png diff --git a/doc/development/img/state-model-merge-request.png b/doc/development/img/state-model-merge-request.png Binary files differnew file mode 100644 index 00000000000..0e7556784f4 --- /dev/null +++ b/doc/development/img/state-model-merge-request.png diff --git a/doc/development/object_state_models.md b/doc/development/object_state_models.md new file mode 100644 index 00000000000..623bbf143ef --- /dev/null +++ b/doc/development/object_state_models.md @@ -0,0 +1,25 @@ +# Object state models + +## Diagrams + +[GitLab object state models](https://drive.google.com/drive/u/3/folders/0B5tDlHAM4iZINmpvYlJXcDVqMGc) + +--- + +## Legend + +![legend](img/state-model-legend.png) + +--- + +## Issue + +[`app/models/issue.rb`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/app/models/issue.rb) +![issue](img/state-model-issue.png) + +--- + +## Merge request + +[`app/models/merge_request.rb`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/app/models/merge_request.rb) +![merge request](img/state-model-merge-request.png)
\ No newline at end of file |