feat: add docs about source of truth #1002
Closed
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces documentation about the "Source of Truth" by updating the sidebar configuration in the docs. The changes close the previous sidebar entry and add a new entry for the "Source of Truth" document.
- Added a new sidebar entry for "Source of Truth" in the best practices section.
- Adjusted the object boundaries to incorporate the new entry.
Files not reviewed (1)
- docs/content/best-practices/source-of-truth.mdx: Language not supported
|
tylernix
previously approved these changes
Apr 9, 2025
|
|
||
| - User data: The source of truth for user profile data is typically an identity provider like Azure, Okta or Auth0. | ||
| - Entity hierarchies: Structures like project/tickets or folder/documents already live in application's databases. Repeatedly querying <ProductName format={ProductNameFormat.ShortForm}/> just to navigate that hierarchy would be inefficient. | ||
| - Data relevant for search and filtering: When performing searches, you need to combine data that's on your database and data that's in <ProductName format={ProductNameFormat.ShortForm}/>. Your application's database is the right place to do filtering/sorting/joins. The data required for performing those operations should live in application's databases. |
There was a problem hiding this comment.
Might be worth giving an example for clarity? Such as storing document.content in the app's database, but store document.owner in FGA.
rhamzeh
reviewed
Apr 9, 2025
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
4 tasks
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.
Description
References
Review Checklist
main