-
Notifications
You must be signed in to change notification settings - Fork 84
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you build the docs and check how it looks? Do we need the png and svg in the codebase? One image + the source code to generate it would be enough.
|
||
## Example { #relationship_model_example } | ||
|
||
<img src="resources/images/relationship_model/relationships.png" width="50%"/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you choose the img
tag to specify the width
? This seems to be the first usage. Other images are added like
<img src="resources/images/relationship_model/relationships.png" width="50%"/> | ||
|
||
* 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*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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*. |
@@ -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 } |
There was a problem hiding this comment.
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.
Adding an example to better explain the relationship model and how we name things