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

Conversation

enricocolasante
Copy link
Contributor

Adding an example to better explain the relationship model and how we name things

@enricocolasante enricocolasante requested a review from a team March 21, 2025 10:40
Copy link
Contributor

@teleivo teleivo left a 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%"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

<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*.
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*.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants