Skip to content

Commit 7da7780

Browse files
authored
chore: clean up admonitions (#2211)
* chore: outdated notice * chore: clean up admonitions
1 parent d561931 commit 7da7780

Some content is hidden

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

42 files changed

+92
-309
lines changed

docs/console/usage-billing.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,6 @@ sidebar_label: Usage-based billing
55
slug: usage-billing
66
---
77

8-
:::info
9-
10-
While we are rolling out usage-based billing, we will not collect payment for overusage. Payment collection will be rolled out
11-
gradually in Q3 2024.
12-
13-
Please report any issues to [email protected] or contact us in the [Ory Community](https://slack.ory.sh/).
14-
15-
:::
16-
178
## Overview
189

1910
Usage-based invoices are a feature in the Ory Console that allows you to understand your usage of Ory Network services, the usage

docs/ecosystem/changelog.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,8 @@ title: Changelog and roadmap
55

66
## Ory Changelog
77

8-
:::info
9-
108
Read the changelog for Ory Network at [changelog.ory.sh](https://changelog.ory.sh/) !
119

12-
:::
13-
1410
> Running security-critical open source technology in a self-service format requires vigilance. We make your life easier by
1511
> announcing important software updates via the [Ory Security Newsletter](https://www.ory.sh/l/sign-up-newsletter). Never miss an
1612
> update and **[sign up now to important release updates!](https://www.ory.sh/l/sign-up-newsletter)**

docs/guides/cli/20_proxy-and-tunnel.mdx

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,6 @@ This behavior is necessary to avoid issues with the browsers
112112

113113
Ory Proxy converts sessions into JSON Web Tokens (JWTs) and ensures that cookies and URLs are properly configured.
114114

115-
:::info
116-
117-
Using Ory Proxy is an alternative to [custom domains (CNAME)](../custom-domains), and a useful tool when developing locally. Read
118-
more about [adding a Custom Domain to your Ory Network project](../custom-domains.mdx) for production setups.
119-
120-
:::
121-
122115
### URL structure
123116

124117
:::tip
@@ -276,18 +269,12 @@ ory proxy --project <project-id> --workspace <workspace-id> --port 8080 http://1
276269
node your-entrypoint.js
277270
```
278271

279-
:::tip
280-
281272
Ory Proxy should never be the main entry point to your application. Always run an ingress proxy such as Nginx or Traefik in front.
282273

283-
:::
284-
285274
### Use Ory Proxy in Docker
286275

287276
To use Ory Proxy in Docker, add your application and Ory Proxy to a single Docker container.
288277

289-
:::info
290-
291278
This isn't a perfect solution as Docker watches the processes running in the foreground. With the application and Ory Proxy in one
292279
container, you must decide which becomes the foreground process.
293280

@@ -299,8 +286,6 @@ In this example, Ory Proxy is the background process.
299286
Read the [Docker documentation](https://docs.docker.com/config/containers/multi-service_container/) to learn more about running
300287
multiple processes in a single container.
301288

302-
:::
303-
304289
To run Ory Proxy in one container with your application, create an `entrypoint.sh` file like this:
305290

306291
```shell

docs/guides/integrate-with-ory-cloud-through-webhooks.mdx

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ else
363363

364364
:::info
365365

366-
Currently, Jsonnet doesn't support regular expressions. Follow this issue to see if the feature has been implemented:
366+
Jsonnet doesn't support regular expressions yet. Follow this issue to see if the feature has been implemented:
367367
[google/go-jsonnet/409](https://github.com/google/go-jsonnet/issues/409).
368368

369369
:::
@@ -406,13 +406,8 @@ config:
406406
```
407407

408408
When the webhook target returns a 200 OK response code and the response body is a JSON object with the key `identity` in it, the
409-
values from that object will be used to change the identity before it is saved to the database.
410-
411-
:::info
412-
413-
Modifying the identity is currently only possible during the registration and settings flows.
414-
415-
:::
409+
values from that object will be used to change the identity before it is saved to the database. Modifying the identity is only
410+
possible during registration and settings flows.
416411

417412
When updating any of the identity fields, be aware that the whole field is replaced by the value returned by the webhook. For
418413
example, if the user signed up with
@@ -456,13 +451,8 @@ complete data:
456451
#### Update identity traits
457452

458453
When the webhook target returns a 200 OK response code and the response body is a JSON object with the key `identity.traits` in
459-
it, the values from that object will be used to replace the identity traits before they are saved to the database.
460-
461-
:::info
462-
463-
This method replaces the entire identity traits object. It is not possible to update only a single trait.
464-
465-
:::
454+
it, the values from that object will be used to replace the identity traits before they are saved to the database. This method
455+
replaces the entire identity traits object. It isn't possible to update only a single trait.
466456

467457
```json
468458
{
@@ -480,13 +470,8 @@ This method replaces the entire identity traits object. It is not possible to up
480470
When the webhook target returns a 200 OK response code and the response body is a JSON object with the key
481471
`identity.metadata_public` or `identity.metadata_admin` in it, the values from that object will be used to replace the
482472
[identity metadata](../kratos/manage-identities/10_managing-users-identities-metadata.mdx) fields before they are saved to the
483-
database.
484-
485-
:::info
486-
487-
This method replaces the entire metadata object. You can't update only a single value in `metadata_public` or `metadata_admin`.
488-
489-
:::
473+
database. This method replaces the entire metadata object. Partial updates to values in `metadata_public` or `metadata_admin`
474+
aren't supported.
490475

491476
```json
492477
{
@@ -509,12 +494,8 @@ When the webhook target returns a 200 OK response code and the response body is
509494
`identity.verifiable_addresses` in it, the values from that object will be used to replace the identity verification addresses
510495
before they are saved to the database.
511496

512-
:::info
513-
514497
Verification and recovery addresses are taken from the `identity.traits` object using the Identity Schema. If you add additional
515-
verification or recovery addresses, these will be deleted unless the Identity traits also contain that address.
516-
517-
:::
498+
verification or recovery addresses, these will be deleted unless the identity traits also contain that address.
518499

519500
```json5
520501
{

docs/guides/manage-project-via-api.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,8 @@ To run this guide you need:
1616
- your **Ory Network project ID** and **Workspace ID**
1717
- a **Workspace API Key**
1818

19-
:::info
20-
2119
To create a new Workspace API Key go to <ConsoleLink route="workspace.settings.apiKeys" />.
2220

23-
:::
24-
2521
### Usage
2622

2723
Use the API Key in API calls, SDK calls, or command-line interactions. Ory Workspace API Keys have a `ory_wak_` prefix, which

docs/hydra/jwks.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,4 @@ ory patch oauth2-config --project <project-id> --workspace <workspace-id> \
112112
--add '/webfinger/jwks/broadcast_keys/-="custom_keyset"'
113113
```
114114

115-
:::info
116-
117115
For more information on how to create a custom keyset, see the [ory create jwk](../cli/ory-create-jwk.md) command.
118-
119-
:::

docs/identities/model/manage-identity-schema.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ Update the identity using the [updateIdentity API](../../reference/api#tag/ident
284284
285285
:::info
286286
287-
The [updateIdentity API](../../reference/api#tag/identity/operation/updateIdentity) overwrites the existing identity with the one provided in the request body. Omit any fields that should not be changed, including the `credentials` field.
287+
The [updateIdentity API](../../reference/api#tag/identity/operation/updateIdentity) overwrites the existing identity with the one provided in the request body. Omit any fields that shouldn't be changed, including the `credentials` field.
288288
289289
:::
290290

docs/identities/session-to-jwt-cors.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ You can customize the JSON Web Token claims by providing a JsonNet template to `
128128

129129
:::info
130130

131-
The `sub` claim can not be customized and is always set to the Ory Session's `IdentityID`.
131+
The `sub` claim can't be customized and is always set to the Ory Session's `IdentityID`.
132132

133133
:::
134134

@@ -170,8 +170,8 @@ ES256, RS256, RS512, and others.
170170

171171
:::info
172172

173-
We recommend using ES256 or ES512 for signing JSON Web Tokens. Avoid using symmetric algorithms such as the HS family (HS256,
174-
HS512, etc).
173+
Ory recommends to use ES256 or ES512 for signing JSON Web Tokens. Avoid symmetric algorithms such as the HS family (HS256, HS512,
174+
etc).
175175

176176
:::
177177

docs/identities/sign-in/login-hint.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,7 @@ ory patch project --project <project-id> --workspace <workspace-id> \
3333

3434
![Ory Account Experience with login hint](./_static/login-hint.png)
3535

36-
:::info
37-
3836
This behavior improves the sign-in experience for your users, but comes at the cost of exposing information about which sign-in
3937
mehods a particular account identifier has associated with it.
4038

4139
Disable this feature if account enumeration attacks are a risk factor in your threat model.
42-
43-
:::

docs/kratos/bring-your-own-ui/05_custom-ui-basic-integration.mdx

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -87,22 +87,11 @@ what security measures are applied.
8787

8888
- Browser applications are apps with which users interact through their web browsers. Two common types of browser applications are
8989
server-side rendered apps (SSR) and single-page apps (SPA). Since the application is rendered in the browser, the communication
90-
between the user that interacts with the app and Ory must be secured. This is achieved by setting a CSRF cookie and token.
91-
92-
:::info
93-
94-
All browser apps must call Ory self-service APIs at `/self-service/{flow_type}/browser`
95-
96-
:::
97-
90+
between the user that interacts with the app and Ory must be secured. This is achieved by setting a CSRF cookie and token. All
91+
browser apps must call Ory self-service APIs at `/self-service/{flow_type}/browser`
9892
- Native applications, such as Android mobile apps or desktop applications, aren't rendered in the browser. Since the application
99-
isn't rendered in the browser, the CSRF cookie and token aren't necessary.
100-
101-
:::info
102-
103-
All native apps must call Ory self-service APIs at `/self-service/{flow_type}/api`
104-
105-
:::
93+
isn't rendered in the browser, the CSRF cookie and token aren't necessary. All native apps must call Ory self-service APIs at
94+
`/self-service/{flow_type}/api`
10695

10796
## Create a flow
10897

0 commit comments

Comments
 (0)