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

Update contributing-model-relationships.md #11377

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

humblenginr
Copy link
Member

Notes for Reviewers

This PR fixes #

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Nithish Karthik <75248557+humblenginr@users.noreply.github.com>
@github-actions github-actions bot added the area/docs Documentation update needed label Jul 11, 2024
Copy link

github-actions bot commented Jul 11, 2024

@l5io
Copy link
Collaborator

l5io commented Jul 11, 2024

@@ -330,6 +329,8 @@ Each policy has a set of evaluation rules defined and the `evaluationQuery` attr
1. To configure a relationship to be applied across all versions of a particular model, ensure the `version` property for those relationships is set to `*`, to limit the relationships to a specific version of a model, specify the correct model version.
1. Specify `version` property as a regex to ensure relationships are applied to a subset of versions of a model.

{% include alert.html title="Caution While Defining Relationships" type="warning" content="Relationships are not imported directly and they have to be packaged inside a model. Use caution when defining relationships that span models." %}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
{% include alert.html title="Caution While Defining Relationships" type="warning" content="Relationships are not imported directly and they have to be packaged inside a model. Use caution when defining relationships that span models." %}
{% include alert.html title="Gratuitous Scoping of Relationships" type="warning" content="Relationships are not imported directly and they have to be packaged inside a model. Use caution when defining relationships that span models." %}

Copy link
Member

Choose a reason for hiding this comment

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

"Relationships are not imported directly and they have to be packaged inside a model." There is some relevance of this information to the warning, but it's not clear what that is given this phrasing and lack of explanation. Please revisit.

Copy link
Member

Choose a reason for hiding this comment

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

"Use caution when defining relationships that span models." Great. Why? Where's the explanation here?

Copy link
Member

Choose a reason for hiding this comment

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

Reviewing again...

This feedback will need to be incorporated prior to merge.

Copy link
Member Author

Choose a reason for hiding this comment

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

Will update it

Copy link
Member

Choose a reason for hiding this comment

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

This feedback has not been addressed.

@@ -330,6 +329,8 @@ Each policy has a set of evaluation rules defined and the `evaluationQuery` attr
1. To configure a relationship to be applied across all versions of a particular model, ensure the `version` property for those relationships is set to `*`, to limit the relationships to a specific version of a model, specify the correct model version.
1. Specify `version` property as a regex to ensure relationships are applied to a subset of versions of a model.

{% include alert.html title="Caution While Defining Relationships" type="warning" content="Relationships are not imported directly and they have to be packaged inside a model. Use caution when defining relationships that span models." %}
Copy link
Member

Choose a reason for hiding this comment

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

"Relationships are not imported directly and they have to be packaged inside a model." There is some relevance of this information to the warning, but it's not clear what that is given this phrasing and lack of explanation. Please revisit.

@@ -330,6 +329,8 @@ Each policy has a set of evaluation rules defined and the `evaluationQuery` attr
1. To configure a relationship to be applied across all versions of a particular model, ensure the `version` property for those relationships is set to `*`, to limit the relationships to a specific version of a model, specify the correct model version.
1. Specify `version` property as a regex to ensure relationships are applied to a subset of versions of a model.

{% include alert.html title="Caution While Defining Relationships" type="warning" content="Relationships are not imported directly and they have to be packaged inside a model. Use caution when defining relationships that span models." %}
Copy link
Member

Choose a reason for hiding this comment

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

"Use caution when defining relationships that span models." Great. Why? Where's the explanation here?

@leecalcote leecalcote added the area/models Models, Components, Relationships related changes label Jul 15, 2024
@Ashparshp
Copy link
Contributor

@humblenginr Could we discuss this issue during the Meshery dev meeting call? Please add it as an agenda item to the meeting minutes.

@leecalcote
Copy link
Member

@humblenginr, thoughts on the feedback offered? Please accept or reject each point of feedback.

Co-authored-by: Lee Calcote <leecalcote@gmail.com>
Signed-off-by: Nithish Karthik <75248557+humblenginr@users.noreply.github.com>
@l5io
Copy link
Collaborator

l5io commented Jul 19, 2024

Copy link
Member

@leecalcote leecalcote left a comment

Choose a reason for hiding this comment

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

The current warning is insufficiently introduced to the reader, leaving them no better off in terms of the objective of this warning.

Signed-off-by: Nithish Karthik <nithishkarthik01@gmail.com>
@humblenginr
Copy link
Member Author

Updated the warning

@l5io
Copy link
Collaborator

l5io commented Jul 20, 2024

Copy link

stale bot commented Sep 1, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the issue/stale Issue has not had any activity for an extended period of time label Sep 1, 2024
@stale stale bot removed the issue/stale Issue has not had any activity for an extended period of time label Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed area/models Models, Components, Relationships related changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants