Conversation
aeneasr
left a comment
aeneasr
left a comment
There was a problem hiding this comment.
We have several hard failures for missing redirects, hard 404s, or potentially broken redirects because the H1 title changed of the redirected-to page.
url,expected_title,vercel_status,vercel_title
https://www.ory.com/docs/actions/live-events,Live event streams | Ory,404,
https://www.ory.com/docs/category/operations-reference,Operations | Ory,200,Scalability | Ory
https://www.ory.com/docs/console/change-owner,Change a project or workspace owner | Ory,404,
https://www.ory.com/docs/console/roles-and-permissions,Roles and permissions in the Ory Console | Ory,404,
https://www.ory.com/docs/console/usage-billing,Usage-based billing | Ory,404,
https://www.ory.com/docs/ecosystem/projects,Introduction | Ory,200,Introduction to Ory Open Source | Ory
https://www.ory.com/docs/ecosystem/sqa,Software quality assurance | Ory,200,Product telemetry and privacy | Ory
https://www.ory.com/docs/getting-started/ory-network-oauth2,Perform OAuth2 Authorization Code Grant and Client Credentials Grant | Ory,200,OAuth2 authorization code and client credentials grants | Ory
https://www.ory.com/docs/getting-started/overview,Quickstarts & Tutorials | Ory,200,Ory Documentation | Ory
https://www.ory.com/docs/guides/custom-domains,Set up custom domains | Ory,404,
https://www.ory.com/docs/guides/gitops,Manage Ory Network configuration in git | Ory,404,
https://www.ory.com/docs/guides/manage-project-via-api,Manage Ory Network projects through the API | Ory,404,
https://www.ory.com/docs/guides/oauth2-oidc,OAuth2 and OpenID Connect | Ory,404,
https://www.ory.com/docs/guides/operations,Operations | Ory,200,Scalability | Ory
https://www.ory.com/docs/guides/permissions/overview,Get started with Permissions in the Ory Network | Ory,200,Get started with Ory Keto | Ory
https://www.ory.com/docs/guides/workspaces,"Ory Network Workspaces, Projects, and Environments | Ory",404,
https://www.ory.com/docs/hydra/reference/configuration,Configuration | Ory,200,Configuration file | Ory
https://www.ory.com/docs/hydra/self-hosted/quickstart,Quickstart | Ory,200,Ory Hydra (OAuth2) Quickstart | Ory
https://www.ory.com/docs/identities,Introduction to Ory Kratos Identities | Ory,200,Introduction to Ory Kratos | Ory
https://www.ory.com/docs/intro,Ory Overview | Ory,200,Introduction to Ory Network | Ory
https://www.ory.com/docs/keto,Introduction to Ory Keto Permissions | Ory,200,Introduction to Ory Keto—Fine-grained Permissions | Ory
https://www.ory.com/docs/keto/examples/olymp-file-sharing,Basic: Olymp library | Ory,200,File sharing example | Ory
https://www.ory.com/docs/keto/quickstart,Quickstart: Cat Videos Example | Ory,200,Ory Keto Quickstart | Ory
https://www.ory.com/docs/keto/reference/configuration,Configuration | Ory,200,Configuration file | Ory
https://www.ory.com/docs/kratos/quickstart,Quickstart | Ory,200,Ory Kratos Quickstart | Ory
https://www.ory.com/docs/oathkeeper/guides/upgrade,Upgrade Ory Oathkeeper OSS | Ory,200,Upgrade Ory Oathkeeper OEL to a newer version | Ory
https://www.ory.com/docs/oathkeeper/reference/configuration,Configuration | Ory,200,Configuration file | Ory
https://www.ory.com/docs/oauth2-oidc,Introduction to Ory Hydra OAuth2 | Ory,200,Introduction to Ory Hydra—Delegated AuthZ & Federated AuthN | Ory
https://www.ory.com/docs/polis,Introduction to Ory Polis | Ory,200,Introduction to Ory Polis—Enterprise SSO AuthZ | Ory
https://www.ory.com/docs/polis/quickstart,Quickstart | Ory,200,Ory Polis Quickstart | Ory
https://www.ory.com/docs/security-compliance/compliance-and-certifications,Compliance and certifications | Ory,200,Security and compliance | Ory
https://www.ory.com/docs/self-hosted/oel/keto/configuration,OEL Configuration | Ory,200,Configuration file | Ory
https://www.ory.com/docs/self-hosted/oel/kratos/configuration,OEL Configuration | Ory,200,Configuration file | Ory
https://www.ory.com/docs/self-hosted/oel/oathkeeper/configuration,OEL Configuration | Ory,200,Configuration file | Ory
https://www.ory.com/docs/self-hosted/oel/oauth2/configuration,OEL Configuration | Ory,200,Configuration file | Ory
https://www.ory.com/docs/welcome,Welcome to Ory! | Ory,200,Ory Documentation | Ory
| id: file-sharing-example | ||
| title: "File sharing example" | ||
| sidebar_label: File sharing example | ||
| --- |
There was a problem hiding this comment.
No canonical needed as only version of this file.
| ```mdx-code-block | ||
| import DocCardList from '@theme/DocCardList'; | ||
| import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; | ||
| {/* import DocCardList from '@theme/DocCardList'; */} |
There was a problem hiding this comment.
Appears to be working OK. https://docs-7qgoc8ot0-ory.vercel.app/docs/category/operations-reference
| ```mdx-code-block | ||
| import DocCardList from '@theme/DocCardList'; | ||
| import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; | ||
| {/* import DocCardList from '@theme/DocCardList'; */} |
There was a problem hiding this comment.
This one is not picking up the sections! https://docs-7qgoc8ot0-ory.vercel.app/docs/guides/oauth2-openid-connect. Need to fix
vercel.json
Outdated
| }, | ||
| { | ||
| "source": "/docs/kratos/bring-your-own-ui/custom-ui-ory-elements", | ||
| "destination": "/docs/getting-started/integrate-auth/nextjs-app-router-quickstart", | ||
| "permanent": true | ||
| "permanent": false |
There was a problem hiding this comment.
DONT change existing redirects!
| }, | ||
| { | ||
| "key": "Cache-Control", | ||
| "value": "max-age=86400, stale-while-revalidate=604800" | ||
| "value": "max-age=2592000, stale-while-revalidate=604800" |
There was a problem hiding this comment.
what about these, the were changed too:
{
"source": "/docs/(img|scripts)/(.*)",
"headers": [
{
"key": "Vercel-CDN-Cache-Control",
"value": "s-maxage=2592000, stale-while-revalidate=604800"
},
{
"key": "CDN-Cache-Control",
"value": "s-maxage=2592000, stale-while-revalidate=604800"
},
{
"key": "Cache-Control",
"value": "max-age=2592000, stale-while-revalidate=604800"
}
]
}
| @@ -1256,15 +1501,15 @@ | |||
| "headers": [ | |||
| { | |||
| "key": "Vercel-CDN-Cache-Control", | |||
| "value": "s-maxage=86400, stale-while-revalidate=604800" | |||
| "value": "s-maxage=2592000, stale-while-revalidate=604800" | |||
| sidebar_label: Scalability | ||
| --- | ||
|
|
||
| import MyPartial from "@site/src/components/Shared/kratos/10_scalability.mdx" |
There was a problem hiding this comment.
The Kratos Courier content is not applicable to Hydra.
There was a problem hiding this comment.
This is existing content that has a high level 'scalability' section that mentions Hydra. Apart from the Mail Courier sub-section, does the high level scalability sections still apply to Hydra?
|
This redesign mentions Polis in the context of SCIM and Enterprise SSO many times. Polis only does SAML, nothing else. REPLY: Please refer to Deepak, I'm 99.999999999% sure Polis support our SCIM functionality. See https://www.ory.com/polis |
|
It is still very confusing for me to find concrete pages. Like for example Hydra Guides. If I start on the OEL page (https://docs-7qgoc8ot0-ory.vercel.app/docs/oel/getting-started) and click Hydra in the sidebar, I have an option "Guides". When I click that, I get a selection of "Running Hydra in Docker" and a couple others, but few details. Whereas when I start on the Ory Network page (https://docs-7qgoc8ot0-ory.vercel.app/docs/network/getting-started) and click on Hydra in the Sidebar, I also see an option Guides. But that link leads me to a completely different set of Hydra Guides which actually explain how to use the product. REPLY: The focus of this round is to create a separate framework for the different deployments. That is why Network has far more content. We have yet to write stuff for OEL. We reorganized the content and will start creating (or reusing/sharing) content where appropriate. |
|
Method: I (with Claude) diffed every Pages dropped from navigationDoc ids present in the old
Pages correctly present in
|
All of these have redirects in the vercel.json file. What are you doing to generate these as errors/404s etc? |
17 participants
Preview link: https://docs-7qgoc8ot0-ory.vercel.app/docs/welcome
Summary
This PR delivers a significant redesign of the Ory documentation site, introducing a new Homepage navigation experience, a new Quick Start page, restructured content architecture, and visual design improvements. It also establishes the foundational framework for separating documentation by deployment model: Ory Network, Ory OEL, and Ory OSS.
Changes
Homepage navigation
Replaced the previous homepage with a guided navigation experience that helps technical evaluators and developers orient quickly and find the right entry point for their use case. (Aligns better with our marketing site.)
Quick Start page
Added a new Quick Start page as a dedicated onboarding path for developers getting started with Ory for the first time.
Content restructuring
Reorganized existing documentation to support clearer content hierarchy. This restructuring is a prerequisite for the deployment-model separation work.
Product overview
Added new high-level product explanations with visual elements to demonstrate how each product fits within the context of an IAM system.
Visual design enhancements
Updated layout, typography, and component styling throughout the portal for improved readability and consistency. Introduced product color association.
Deployment model framework
Introduced the structural scaffolding to separate documentation by deployment context — Ory Network, Ory OEL, and Ory OSS — enabling product-specific content targeting in follow-on PRs.
What's not included
Full content separation by deployment model is out of scope for this PR. This change puts the framework in place; content migration and product-specific pages will follow.
Complete alignment on product names is out of the scope of this PR.
TESTING
New feature documentation (last few months)
Verify your new content appears in the redesigned navigation (docs/sidebar.ts). If it doesn't appear, add it to the /docs/sidebar.ts.
NOTE: There are several new sidebar files located within the /docs folder; if your content was added to the previous sidebar.ts file located in /src that file is no longer in use.
Content is complete
Verify that your product area contains the expected full set of content. The restructure may have affected navigation visibility for some pages.
Broken links
Spot-check links in your product area. Internal navigation files were significantly changed in this redesign.
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.