-
Notifications
You must be signed in to change notification settings - Fork 1.8k
chore: add page on feature deprecations #2453
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jonas-jonas
wants to merge
7
commits into
master
Choose a base branch
from
jonas-jonas/addDeprecatedFeatures
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+631
−2
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8b55564
chore: add page on feature deprecations
jonas-jonas 015ea7e
chore: apply suggestions from code review
vinckr 1b9d7e4
Merge remote-tracking branch 'origin/master' into jonas-jonas/addDepr…
jonas-jonas f1615cb
chore: rm sidebar
jonas-jonas c5ea136
docs: spec for deprecated-features migration intake plan
jonas-jonas 277495c
chore: add descriptions for additional features
jonas-jonas 934299a
chore: move deprecation guides to sections on docs pages
jonas-jonas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| id: index | ||
| title: Feature deprecations | ||
| sidebar_label: Feature deprecations | ||
| --- | ||
|
|
||
| This section lists deprecated behavior in Ory Kratos. Check this section regularly to avoid relying on deprecated functionality. | ||
|
|
||
| ## Who does this apply to? | ||
|
|
||
| Users of the Ory Network, Ory Kratos (open source) and the OEL (Ory Enterprise License) are affected by this section. | ||
|
|
||
| ## How to use this section | ||
|
|
||
| Documentation for each deprecated feature now lives alongside the feature it affects. Each entry provides information about the | ||
| deprecated feature, including: | ||
|
|
||
| - A brief description of the feature and its purpose. | ||
| - The reason for deprecation, if available. | ||
| - The version in which the feature was deprecated. | ||
| - Any recommended alternatives or migration paths, if applicable. | ||
|
|
||
| If you're using an Ory Network project, your configuration will not change, unless you have explicitly disabled the deprecated | ||
| feature via a project level feature flag. To check which flags are currently enabled, go to | ||
|
|
||
| <ConsoleLink route="project.settings.advanced" />. | ||
|
jonas-jonas marked this conversation as resolved.
|
||
|
|
||
| If you're self-hosting Ory Kratos (either through open source or the OEL), you should review your configuration and codebase to | ||
| identify any usage of deprecated features before upgrading to a new version. This will help you avoid any potential issues that | ||
| may arise from the removal of deprecated features in future releases. | ||
|
|
||
| ## Stay informed | ||
|
|
||
| Subscribe to the [Ory Changelog](https://changelog.ory.com) to receive updates on new releases, including information about | ||
| deprecated features and their removal timelines. Additionally, consider joining the Ory community on Slack or GitHub to stay | ||
| engaged with other users and developers, and to get support for any questions or issues related to deprecated features. | ||
|
|
||
| ## Impacted functionality | ||
|
|
||
| Deprecation notes are documented with the features they affect: | ||
|
|
||
| - **Admin session extension API (`faster_session_extend`)** — | ||
| [Refresh sessions](../session-management/20_refresh-extend-session.mdx) | ||
| - **Web hook interrupts (`can_interrupt`)** — | ||
| [Trigger custom logic and integrate with external systems with webhooks](../../guides/integrate-with-ory-cloud-through-webhooks.mdx) | ||
| - **WebAuthn and passkey relying party origin (`rp.origin` and `rp.icon`)** — | ||
| [Passkeys & WebAuthN](../passwordless/05_passkeys.mdx) | ||
| - **Link strategy base URL (`link.config.base_url`)** — | ||
| [Wrong domain in magic links](../../troubleshooting/magic-link-verification-url.mdx) | ||
| - **One-step registration (`enable_legacy_one_step`)** — | ||
| [Two-step registration](../../identities/sign-in/two-step-registration.mdx) | ||
| - **OIDC registration node group (`legacy_oidc_registration_node_group`)** — | ||
| [UI node groups](../concepts/ui-user-interface.mdx#ui-node-groups) | ||
| - **Password registration node group (`password_profile_registration_node_group`)** — | ||
| [UI node groups](../concepts/ui-user-interface.mdx#ui-node-groups) | ||
| - **Verification UI in `continue_with` (`legacy_continue_with_verification_ui`)** — | ||
| [Address verification](../../actions/require-verified-address.mdx) | ||
| - **Verified-address login error (`legacy_require_verified_login_error`)** — | ||
| [Address verification](../../actions/require-verified-address.mdx) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.