Skip to content

fix: update installation guides and sidebar paths#2613

Open
wassimoo wants to merge 5 commits into
masterfrom
fix/setup-guides-across-deployment-models
Open

fix: update installation guides and sidebar paths#2613
wassimoo wants to merge 5 commits into
masterfrom
fix/setup-guides-across-deployment-models

Conversation

@wassimoo

@wassimoo wassimoo commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Ory Network - identities/get-started/setup

  • Replaced inline macOS brew snippet with the reusable component
  • Added missing Linux and Windows CLI install tabs using and components
  • Fixed tunnel command syntax: ory tunnel --project $ORY_PROJECT_ID --port 4000 http://localhost:3000

Shared: _common/install.mdx

  • Replaced separate OS sections (Linux, macOS, Windows, Docker, Kubernetes) with a single tabbed block
  • Fixed undefined help in macOS tab by defaulting command to repo when not passed

OEL / OSS - kratos/install

  • Updated sidebar paths and shell files for Kratos to prevent routing users to the wrong deployment.

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    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.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Summary by CodeRabbit

  • Documentation
    • Updated documentation sidebar links so the Kratos and Keto “install” pages now point to the new Open Source locations.
    • Removed legacy changelog entries from the open-source sidebar so users move directly from install/upgrade to the next relevant sections.
    • Updated documentation rules to require creating a URL redirect before deleting a doc page.
    • Added permanent redirects to forward the old Kratos/Keto install URLs to the new locations.

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The 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.

Changes

Documentation Structure and Redirect Policy Update

Layer / File(s) Summary
Contributor redirect policy
AGENTS.md
Added explicit guidance requiring a Vercel redirect before deleting any documentation page.
Sidebar navigation restructuring
sidebars-oel.ts, sidebars-oss.ts
OEL sidebar paths updated: Kratos install to oel/kratos/install, Keto install to oel/keto/install. OSS sidebar paths updated to oss/kratos/install and oss/keto/install. Removed legacy self-hosted/oel/*/changelog entries from Kratos, Keto, Hydra, Polis, and Oathkeeper sections.
URL redirect implementation
vercel.json
Added permanent Vercel redirects: /docs/kratos/install/docs/oss/kratos/install and /docs/keto/install/docs/oss/keto/install.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • ory/docs#2522: Introduced AGENTS.md with initial contributor guidance; this PR extends it with an explicit rule about deletion redirects.

Suggested reviewers

  • unatasha8

Poem

🐰 I hopped through sidebars, nudged old paths away,
Built redirects so lost links find home to stay.
A rule now guards each page before it goes,
Safe navigation blooms wherever it flows. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The PR description covers the main changes across three areas (Ory Network setup, shared install component, and Kratos/OEL/OSS paths) and includes a completed checklist, though it lacks explicit issue/design document references as suggested by the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title 'fix: update installation guides and sidebar paths' is partially related to the main changeset. While it mentions sidebar paths which are updated in multiple files, it does not capture the most important change: adding Vercel redirects to maintain old documentation URLs (a critical documentation maintenance step per AGENTS.md guidelines), which is a primary objective of this PR.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/setup-guides-across-deployment-models

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@unatasha8 unatasha8 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Comment thread vercel.json
},
{
"source": "/docs/kratos/install",
"destination": "/docs/oss/kratos/install",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the redirect should be to /docs/oel (oel takes precedence over oss)

Comment thread vercel.json
},
{
"source": "/docs/keto/install",
"destination": "/docs/oss/keto/install",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the redirect should be to /docs/oel (oel takes precedence over oss)

Comment thread docs/oss/keto/install.mdx
```

```mdx-code-block
import Install from '@site/docs/_common/install.mdx'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This still points to docs/_common

Comment thread docs/oel/keto/install.mdx
```

```mdx-code-block
import Install from '@site/docs/_common/install.mdx'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This still points to docs/_common

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.)

@wassimoo wassimoo changed the title fix: update installation guides and sidebar paths for kratos fix: update installation guides and sidebar paths Jun 18, 2026
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.

3 participants