fix: update installation guides and sidebar paths#2613
Conversation
📝 WalkthroughWalkthroughThe PR updates sidebar navigation across OEL and OSS documentation editions, consolidates Kratos and Keto installation paths, removes legacy changelog entries from five product sidebars, establishes a contributor policy requiring Vercel redirects before page deletion, and implements permanent URL redirects for the affected paths. ChangesDocumentation Structure and Redirect Policy Update
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
unatasha8
left a comment
There was a problem hiding this comment.
Please see https://app.notion.com/p/Updating-Ory-Documentation-Post-Redesign-34afadbbf3c980b699d2e736b952a324 for "How to Update Content (Migrated Sections)".
| }, | ||
| { | ||
| "source": "/docs/kratos/install", | ||
| "destination": "/docs/oss/kratos/install", |
There was a problem hiding this comment.
the redirect should be to /docs/oel (oel takes precedence over oss)
| }, | ||
| { | ||
| "source": "/docs/keto/install", | ||
| "destination": "/docs/oss/keto/install", |
There was a problem hiding this comment.
the redirect should be to /docs/oel (oel takes precedence over oss)
| ``` | ||
|
|
||
| ```mdx-code-block | ||
| import Install from '@site/docs/_common/install.mdx' |
There was a problem hiding this comment.
This still points to docs/_common
| ``` | ||
|
|
||
| ```mdx-code-block | ||
| import Install from '@site/docs/_common/install.mdx' |
There was a problem hiding this comment.
This still points to docs/_common
There was a problem hiding this comment.
The install file describes install content for OSS and OEL. The install content should be different for each deployment. (OEL has binaries. OSS has to build binaries from source.) Separate content into different files. (It's not just a case of having a file for each deployment, the content in the files should be focused on that deployment.)
Ory Network - identities/get-started/setup
ory tunnel --project $ORY_PROJECT_ID --port 4000 http://localhost:3000Shared: _common/install.mdx
OEL / OSS - kratos/install
Checklist
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
Summary by CodeRabbit