Skip to content

docs: migrate kratos debug docs to deployment structure#2678

Merged
hperl merged 1 commit into
kratos-auth-deployment-structurefrom
kratos-debug-deployment-structure
Jul 13, 2026
Merged

docs: migrate kratos debug docs to deployment structure#2678
hperl merged 1 commit into
kratos-auth-deployment-structurefrom
kratos-debug-deployment-structure

Conversation

@hperl

@hperl hperl commented Jul 13, 2026

Copy link
Copy Markdown
Member

Fixes the sidebar hijack on the kratos debug/troubleshooting pages: they were autogenerated into both the OEL and OSS sidebars (dirName: "kratos/debug"), and since Docusaurus associates each doc with exactly one sidebar, opening e.g. /docs/kratos/debug/csrf from the OEL tree reshuffled the navigation into OSS. Same bug class as #2674, applied to the self-hosted deployments.

  • Page bodies move to shared partials under src/components/Shared/kratos/debug/ (the two CommonMark .md pages keep their extension — format: "detect" — so they stay JSX-free).
  • Thin shells under docs/oel/kratos/debug/ and docs/oss/kratos/debug/; each deployment's sidebar autogenerates from its own directory, so OEL and OSS readers keep their own navigation.
  • Canonical rule: these pages are self-hosted-only, so the self-hosted exception applies — OEL shells are self-canonical and the OSS shells' canonicals point at the OEL URLs. No Network shells (Network never listed these pages).
  • Old URLs (/docs/kratos/debug/*) 308-redirect to the OEL pages.
  • Inbound links updated: docs/troubleshooting/10_crsf.mdx uses SameDeploymentLink with a network= override (no Network shell exists), and the CommonMark guide setting-up-password-hashing-parameters.md points at the canonical OEL URL.

Related Issue or Design Document

Part of #2674.

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

Further comments

Stacked on #2675 (base is its branch, so this diff shows only the debug migration; GitHub retargets to master when #2675 merges). Full docusaurus build passes; the only remaining warnings are the pre-existing /docs/reference/openapi/* and /docs/reference/api#operation/* ones that exist on master too.

🤖 Generated with Claude Code

The debug pages were autogenerated into both the OEL and OSS sidebars,
so one deployment always hijacked the other's navigation (#2674). Move
them to shared partials with OEL and OSS shells; OEL is canonical per
the self-hosted exception.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@hperl hperl self-assigned this Jul 13, 2026
@hperl hperl merged commit 843a22f into kratos-auth-deployment-structure Jul 13, 2026
3 of 4 checks passed
@hperl hperl deleted the kratos-debug-deployment-structure branch July 13, 2026 17:52
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.

1 participant