Skip to content

Commit 3275ee3

Browse files
committed
Merge branch 'master' into una-MigGuideUpdate
2 parents e1650cf + 39ead55 commit 3275ee3

File tree

220 files changed

+3899
-2410
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

220 files changed

+3899
-2410
lines changed

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ body:
2525
Guidelines](https://github.com/ory/docs/blob/master/CONTRIBUTING.md)."
2626
required: true
2727
- label:
28-
"I have joined the [Ory Community Slack](https://slack.ory.sh)."
28+
"I have joined the [Ory Community Slack](https://slack.ory.com)."
2929
- label:
3030
"I am signed up to the [Ory Security Patch
31-
Newsletter](https://www.ory.sh/l/sign-up-newsletter)."
31+
Newsletter](https://www.ory.com/l/sign-up-newsletter)."
3232
id: checklist
3333
type: checkboxes
3434
- attributes:

.github/ISSUE_TEMPLATE/DESIGN-DOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ body:
3636
Guidelines](https://github.com/ory/docs/blob/master/CONTRIBUTING.md)."
3737
required: true
3838
- label:
39-
"I have joined the [Ory Community Slack](https://slack.ory.sh)."
39+
"I have joined the [Ory Community Slack](https://slack.ory.com)."
4040
- label:
4141
"I am signed up to the [Ory Security Patch
42-
Newsletter](https://www.ory.sh/l/sign-up-newsletter)."
42+
Newsletter](https://www.ory.com/l/sign-up-newsletter)."
4343
id: checklist
4444
type: checkboxes
4545
- attributes:

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ body:
2929
Guidelines](https://github.com/ory/docs/blob/master/CONTRIBUTING.md)."
3030
required: true
3131
- label:
32-
"I have joined the [Ory Community Slack](https://slack.ory.sh)."
32+
"I have joined the [Ory Community Slack](https://slack.ory.com)."
3333
- label:
3434
"I am signed up to the [Ory Security Patch
35-
Newsletter](https://www.ory.sh/l/sign-up-newsletter)."
35+
Newsletter](https://www.ory.com/l/sign-up-newsletter)."
3636
id: checklist
3737
type: checkboxes
3838
- attributes:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ contact_links:
99
Please ask and answer questions here, show your implementations and
1010
discuss ideas.
1111
- name: Ory Chat
12-
url: https://www.ory.sh/chat
12+
url: https://www.ory.com/chat
1313
about:
1414
Hang out with other Ory community members to ask and answer questions.

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Pull requests introducing new features, which do not have a design document link
2424
get merged.
2525
2626
You can discuss changes with maintainers either in the Github Discussions in this repository or
27-
join the [Ory Chat](https://www.ory.sh/chat).
27+
join the [Ory Chat](https://www.ory.com/chat).
2828
-->
2929

3030
## Checklist
@@ -39,7 +39,7 @@ them, don't hesitate to ask. We're here to help! This is simply a reminder of wh
3939
- [ ] I have read the [security policy](../security/policy).
4040
- [ ] I confirm that this pull request does not address a security vulnerability.
4141
If this pull request addresses a security vulnerability,
42-
I confirm that I got approval (please contact [security@ory.sh](mailto:security@ory.sh)) from the maintainers to push the changes.
42+
I confirm that I got approval (please contact [security@ory.com](mailto:security@ory.com)) from the maintainers to push the changes.
4343
- [ ] I have added tests that prove my fix is effective or that my feature works.
4444
- [ ] I have added the necessary documentation within the code base (if appropriate).
4545

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ docs/keto/reference/proto-api.mdx
1616
vendor
1717
code-examples/sdk/typescript/src/**/*.hbs
1818
**/.dart_tool
19+
**/*.jsonc

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ individual problems. If Ory open source software is used in production in a
4747
for-profit company or enterprise environment, we mandate a paid support contract
4848
where Ory is obligated under their service level agreements (SLAs) to offer a
4949
defined level of availability and responsibility. For more information about
50-
paid support please contact us at sales@ory.sh.
50+
paid support please contact us at sales@ory.com.
5151

5252
## Enforcement Responsibilities
5353

@@ -73,7 +73,7 @@ representative at an online or offline event.
7373

7474
Instances of abusive, harassing, or otherwise unacceptable behavior may be
7575
reported to the community leaders responsible for enforcement at
76-
[office@ory.sh](mailto:office@ory.sh). All complaints will be reviewed and
76+
[office@ory.com](mailto:office@ory.com). All complaints will be reviewed and
7777
investigated promptly and fairly.
7878

7979
All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
_Please note_: We take Ory Documentation's security and our users' trust very
2626
seriously. If you believe you have found a security issue in Ory Documentation,
27-
please disclose it by contacting us at security@ory.sh.
27+
please disclose it by contacting us at security@ory.com.
2828

2929
There are many ways in which you can contribute. The goal of this document is to
3030
provide a high-level overview of how you can get involved in Ory.
@@ -44,7 +44,7 @@ won't clash with Ory
4444
Documentation's direction. A great way to
4545
do this is via
4646
[Ory Documentation Discussions](https://github.com/orgs/ory/discussions)
47-
or the [Ory Chat](https://www.ory.sh/chat).
47+
or the [Ory Chat](https://www.ory.com/chat).
4848

4949
## FAQ
5050

@@ -67,7 +67,7 @@ or the [Ory Chat](https://www.ory.sh/chat).
6767
[a Contributors License Agreement?](https://cla-assistant.io/ory/docs)
6868

6969
- I would like updates about new versions of Ory Documentation.
70-
[How are new releases announced?](https://www.ory.sh/l/sign-up-newsletter)
70+
[How are new releases announced?](https://www.ory.com/l/sign-up-newsletter)
7171

7272
## How can I contribute?
7373

@@ -109,15 +109,15 @@ to help out:
109109

110110
## Communication
111111

112-
We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask
112+
We use [Slack](https://www.ory.com/chat). You are welcome to drop in and ask
113113
questions, discuss bugs and feature requests, talk to other users of Ory, etc.
114114

115115
Check out [Ory Documentation Discussions](https://github.com/orgs/ory/discussions). This is a great place for
116116
in-depth discussions and lots of code examples, logs and similar data.
117117

118118
You can also join our community calls if you want to speak to the Ory team
119119
directly or ask some questions. You can find more info and participate in
120-
[Slack](https://www.ory.sh/chat) in the #community-call channel.
120+
[Slack](https://www.ory.com/chat) in the #community-call channel.
121121

122122
If you want to receive regular notifications about updates to Ory Documentation,
123123
consider joining the mailing list. We will _only_ send you vital information on
@@ -139,7 +139,7 @@ to add your example or Ory-related project to the awesome-ory README.
139139
## Contribute code
140140

141141
Unless you are fixing a known bug, we **strongly** recommend discussing it with
142-
the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat)
142+
the core team via a GitHub issue or [in our chat](https://www.ory.com/chat)
143143
before getting started to ensure your work is consistent with Ory Documentation's
144144
roadmap and architecture.
145145

@@ -208,7 +208,7 @@ instructions please head over to the Ory Documentation
208208
## Disclosing vulnerabilities
209209

210210
Please disclose vulnerabilities exclusively to
211-
[security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues.
211+
[security@ory.com](mailto:security@ory.com). Do not use GitHub issues.
212212

213213
## Code style
214214

@@ -250,4 +250,4 @@ community a safe place for you and we've got your back.
250250

251251
We welcome discussion about creating a welcoming, safe, and productive
252252
environment for the community. If you have any questions, feedback, or concerns
253-
[please let us know](https://www.ory.sh/chat).
253+
[please let us know](https://www.ory.com/chat).

README.md

Lines changed: 71 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<h1 align="center">Ory Documentation</h1>
22

33
<h4 align="center">
4-
<a href="https://www.ory.sh/chat">Chat</a> |
5-
<a href="https://www.ory.sh/l/sign-up-newsletter">Newsletter</a><br/><br/>
6-
<a href="https://www.ory.sh/docs/">Documentation</a> |
4+
<a href="https://www.ory.com/chat">Chat</a> |
5+
<a href="https://www.ory.com/l/sign-up-newsletter">Newsletter</a><br/><br/>
6+
<a href="https://www.ory.com/docs/">Documentation</a> |
77
<a href="https://opencollective.com/ory">Support this project!</a><br/><br/>
8-
<a href="https://www.ory.sh/jobs/">Work in Open Source, Ory is hiring!</a>
8+
<a href="https://www.ory.com/jobs/">Work in Open Source, Ory is hiring!</a>
99
</h4>
1010

1111
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -32,20 +32,26 @@
3232
- [Screenshots and videos](#screenshots-and-videos)
3333
- [Compressing images](#compressing-images)
3434
- [Recording and compressing videos](#recording-and-compressing-videos)
35+
- [Ory Console](#ory-console)
36+
- [Navigate to Ory Console Pages](#navigate-to-ory-console-pages)
3537
- [Testing](#testing)
3638
- [Formatting documentation](#formatting-documentation)
3739
- [Adding content to "Examples" page](#adding-content-to-examples-page)
3840
- [CLI and API reference - auto-generated content](#cli-and-api-reference---auto-generated-content)
41+
- [CanonicalURL](#canonicalurl)
42+
- [When to use CanonicalURL](#when-to-use-canonicalurl)
43+
- [How to use CanonicalURL](#how-to-use-canonicalurl)
44+
- [How to verify CanonicalURL is working](#how-to-verify-canonicalurl-is-working)
3945

4046
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
4147

4248
# Overview
4349

4450
Ory documentation is the single source of truth for usage, implementation,
4551
configuration, and troubleshooting of the Ory Network and all projects of the
46-
[Ory Ecosystem](https://www.ory.sh/docs/ecosystem/projects/). The documentation
52+
[Ory Ecosystem](https://www.ory.com/docs/ecosystem/projects/). The documentation
4753
is best consumed through the
48-
[Ory documentation portal](https://www.ory.sh/docs/).
54+
[Ory documentation portal](https://www.ory.com/docs/).
4955

5056
To see the source code of each of the projects, visit the project repository:
5157

@@ -419,7 +425,7 @@ import VideoEmbed from '@site/src/components/VideoEmbed'
419425
You can use the `/current/` route to navigate users to their active Ory Network
420426
project. For example, to access the Custom UI settings for the active Ory
421427
Network project in the Console, you can link to:
422-
https://console.ory.sh/projects/current/ui
428+
https://console.ory.com/projects/current/ui
423429

424430
When referencing a page of the Ory Console, use the
425431
`<ConsoleLink route="project..." />` component in MDX files.
@@ -540,3 +546,61 @@ The `cmd/clidoc/main.go` is the general path for all Ory projects.
540546

541547
The command to generate the CLI docs can be found here:
542548
https://github.com/ory/x/blob/master/clidoc/generate.go#L96
549+
550+
## CanonicalURL
551+
552+
The `CanonicalURL` component specifies the authoritative URL for a page to
553+
search engines. Docusaurus adds trailing slashes to `index.mdx` files and files
554+
matching their parent directory names before Vercel's trailing slash removal
555+
takes effect. This means search engines can crawl both versions (with and
556+
without trailing slashes). The component ensures search engines know which
557+
version is canonical by explicitly setting a URL without a trailing slash.
558+
559+
### When to use CanonicalURL
560+
561+
Use this component on:
562+
563+
- **Any `index.mdx` file**: These files serve content at their parent path
564+
(e.g., `/api/index.mdx`)
565+
- **Files matching parent directory names**: When a file shares its parent
566+
directory's name (e.g., `docs/kratos/organizations/organizations.mdx`)
567+
568+
Common examples include:
569+
570+
- Index Path (`/api/index.mdx`, `/elements/index.mdx`, `/identities/index.mdx`)
571+
- Matching parent directory names
572+
(`docs/kratos/organizations/organizations.mdx`,
573+
`docs/self-hosted/oel/monitoring/monitoring.mdx`)
574+
575+
### How to use CanonicalURL
576+
577+
Add the component at the beginning of your MDX file after the front matter:
578+
579+
````md
580+
---
581+
id: your-page-id
582+
title: Your Page Title
583+
---
584+
585+
```mdx-code-block
586+
import CanonicalURL from "@site/src/components/CanonicalUrl"
587+
588+
<CanonicalURL path="your/canonical/path" />
589+
590+
Your content here...
591+
```
592+
````
593+
594+
### How to verify CanonicalURL is working
595+
596+
1. Open the page in your browser
597+
2. Right-click and select "View Page Source" (not "Inspect")
598+
3. Search for `<link rel="canonical"` in the HTML
599+
4. Confirm the canonical URL exists and points to the correct path without
600+
trailing slash
601+
602+
Example:
603+
604+
```html
605+
<link rel="canonical" href="https://www.ory.com/docs/kratos/organizations" />
606+
```

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This policy outlines Ory's security commitments and practices for users across
77
different licensing and deployment models.
88

99
To learn more about Ory's security service level agreements (SLAs) and
10-
processes, please [contact us](https://www.ory.sh/contact/).
10+
processes, please [contact us](https://www.ory.com/contact/).
1111

1212
## Ory Network Users
1313

@@ -53,4 +53,4 @@ processes, please [contact us](https://www.ory.sh/contact/).
5353
## Reporting a Vulnerability
5454

5555
For details on how to report security vulnerabilities, visit our
56-
[security policy documentation](https://www.ory.sh/docs/ecosystem/security).
56+
[security policy documentation](https://www.ory.com/docs/ecosystem/security).

0 commit comments

Comments
 (0)