Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add example to relationship model [DHIS2-19169] #1529

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/user/relationship-model.md
Original file line number Diff line number Diff line change
@@ -71,3 +71,15 @@ One important thing to note about bidirectional relationships, are that the
"from" and "to" sides are still significant in the database, meaning each entity
must match the constraint for that side. However, from a user perspective, which
side each entity is stored as is insignificant.

## Example { #relationship_model_example }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how exactly but it would be great if that image would integrate with all of the text above. I think that would make the text easier to understand. Also an image where the relationships are nodes with from/to edges would help.


<img src="resources/images/relationship_model/relationships.png" width="50%"/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


* Bidirectional relationship *relA* connects *teA* to *teB* and connects *teB* to *teA*.
* Unidirectional relationship *relB* connects *teA* to *teC* but DO NOT connect *teC* to *teA*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Unidirectional relationship *relB* connects *teA* to *teC* but DO NOT connect *teC* to *teA*.
* Unidirectional relationship *relB* connects *teA* to *teC* but DOES NOT connect *teC* to *teA*.

* *teA* originates relationships *relA* and *relB*.
* *teB* originates relationships *relA*.
* *teC* originates no relationships.
* *relA* originates from *teA* and from *teB*, and points to *teA* and to *teB*.
* *relB* originates from *teA* and points to *teC*.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions src/user/resources/images/relationship_model/relationships.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.