Moved the "Running OpenFGA in prod" to the best practices section #996
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
There was a problem hiding this comment.
Pull Request Overview
This PR moves the "Production Best Practices" content to a new location under the Best Practices section, updating titles, link paths, and sidebar references accordingly.
- Updated configuration page link and ID to point to the new best practices location.
- Removed legacy production best practices documentation from getting-started and added a new entry under Best Practices in the sidebar and README.
Reviewed Changes
Copilot reviewed 3 out of 12 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/update-config-page.mjs | Updated title, link, and id for the production best practices page. |
| docs/sidebars.js | Adjusted sidebar items to remove the legacy entry and add the new link. |
| docs/README.md | Removed old production best practices link and added new Best Practices entries. |
Files not reviewed (9)
- docs/content/best-practices/adoption-patterns.mdx: Language not supported
- docs/content/best-practices/overview.mdx: Language not supported
- docs/content/best-practices/running-in-production.mdx: Language not supported
- docs/content/getting-started/overview.mdx: Language not supported
- docs/content/getting-started/setup-openfga/access-control.mdx: Language not supported
- docs/content/getting-started/setup-openfga/configuration.mdx: Language not supported
- docs/content/getting-started/setup-openfga/configure-openfga.mdx: Language not supported
- docs/content/getting-started/setup-openfga/docker-setup.mdx: Language not supported
- docs/content/getting-started/setup-sdk-client.mdx: Language not supported
Comments suppressed due to low confidence (3)
scripts/update-config-page.mjs:234
- Please verify that the updated relative link correctly points to the best practices page in the new folder structure.
link: './../../best-practices/running-in-production',
docs/sidebars.js:406
- [nitpick] Consider if the label should emphasize best practices more directly (e.g., 'OpenFGA Production Best Practices') to align with documentation terminology.
label: 'Running OpenFGA in Production',
docs/README.md:81
- Verify that the referenced document './content/best-practices/running-in-production.mdx' exists and is correctly integrated into the documentation structure.
- [Running OpenFGA in Production](./content/best-practices/running-in-production.mdx)
aaguiarz
changed the title
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
We moved
https://openfga.dev/docs/getting-started/running-in-production to
https://openfga.dev/docs/best-practices/running-in-production. We'd need to redirect in Cloudflare.
References
Review Checklist
main