chore(docs): refine the "getting started with modeling" page #656
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a first-half edit of a very, very long document. I know that this is a lot to look over, so feel free to schedule me for a Zoom call so we can talk edits over before you merge.
|
rhamzeh
requested changes
Mar 6, 2024
| If you can answer that question for all types of objects in your system, then you can codify that into an authorization model. | ||
|
|
||
| Let's get started! | ||
| Answering that question for all object types in your system codifies your authorization model. |
There was a problem hiding this comment.
I don't think this is saying the same thing as the previous sentence.
It used to say, finish these steps then you can write your authorization model, now it says: finishes these steps and you would have written your authorization model
There was a problem hiding this comment.
How about:
Answering that question for all object types in your system means your authorization model can be codified.
| In a few cases other users can be part of determining whether an action can be performed on an action or not. Social media is an example of this "a user can comment on a picture if they are a friend of the user that published it". | ||
| Though you're in the process of building a version you can use, the model above is not yet a valid authorization model accepted by <ProductName format={ProductNameFormat.ShortForm}/>. | ||
|
|
||
| In a few cases, other users can determine whether one action can be performed on another action. For example, on social media, sometimes a user can comment on a picture if they are a friend of the user that published it. |
There was a problem hiding this comment.
I don't think this whole note is helpful here, let's remove it. It used to be back in back in the day where we didn't require a type for an object
|
|
||
| In those cases [**User** should also be an object type](./building-blocks/object-to-object-relationships.mdx). Following the last recommendation, we would discover the User type because it is a second noun in an expression: "friend of the user". | ||
| In those cases [**User** must be an object type](./building-blocks/object-to-object-relationships.mdx), and you would discover the User type because it is a second noun in an expression `friend of the user`. |
rhamzeh
changed the title
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a first-half edit of a very, very long document.
I know that this is a lot to look over, so feel free to schedule me for a Zoom call so we can talk edits over before you merge.
Description
References
Review Checklist
main