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 modular-models.mdx #714

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update modular-models.mdx #714

wants to merge 1 commit into from

Conversation

pavokta
Copy link
Contributor

@pavokta pavokta commented Apr 9, 2024

Tightened up the tone, context, and tenses. QOL edits. Please contact me with any questions!

Description

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Tightened up the tone, context, and tenses. QOL edits. Please contact me with any questions!
@pavokta pavokta requested a review from a team as a code owner April 9, 2024 21:43
Copy link
Contributor

github-actions bot commented Apr 9, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://openfga.github.io/openfga.dev/pr-preview/pr-714/
on branch gh-pages at 2024-04-09 21:46 UTC

Copy link
Member

@ewanharris ewanharris left a comment

Choose a reason for hiding this comment

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

Thanks for tidying this up @pavokta! Do you think the suggestions I made make sense?


- A model can grow large and difficult to understand
- As more teams begin to contribute to a model, the ownership boundaries may not be clear and code review processes might not scale
As authorization models grow larger and more difficult to understand as more teams contribute to a model. As a result, model ownership boundaries may not be clear and code review processes might not scale.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe a lead in to this might help?

Suggested change
As authorization models grow larger and more difficult to understand as more teams contribute to a model. As a result, model ownership boundaries may not be clear and code review processes might not scale.
As adoption of <ProductName format={ProductNameFormat.ShortForm}/> increases, authorization models can grow larger and more difficult to understand. As a result, model ownership boundaries may not be clear and code review processes might not scale.


### Type Extensions

As teams implement features, they might find that core types they are dependent upon might not contain all the realtions they need. However, it might not make sense for these relations to be owned by the owner of that type if they aren't needed across the system.
In some cases, core module types that admin teams depend on might not contain all the relations they need. However, if those module types aren't needed across the system, it doesn't make sense for those relations to be owned by that type's owner.
Copy link
Member

Choose a reason for hiding this comment

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

I think admin might not be needed here

Suggested change
In some cases, core module types that admin teams depend on might not contain all the relations they need. However, if those module types aren't needed across the system, it doesn't make sense for those relations to be owned by that type's owner.
In some cases, core module types that teams depend on might not contain all the relations they need. However, if those module types aren't needed across the system, it doesn't make sense for those relations to be owned by that type's owner.

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.

None yet

3 participants