Skip to content

chore: add page on feature deprecations#2453

Open
jonas-jonas wants to merge 1 commit intomasterfrom
jonas-jonas/addDeprecatedFeatures
Open

chore: add page on feature deprecations#2453
jonas-jonas wants to merge 1 commit intomasterfrom
jonas-jonas/addDeprecatedFeatures

Conversation

@jonas-jonas
Copy link
Member

Related Issue or Design Document

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

Copy link
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some style changes

Comment on lines +12 to +16
Ory is committed to maintaining a high level of quality and performance in our products, and deprecating features is a rare but
necessary step to ensure that we can continue to innovate and improve our offerings. We understand that deprecations can be
disruptive, and we strive to provide clear communication and ample time for users to adapt to changes. We encourage users to
review the deprecation information provided in this section and to reach out to our support channels if they have any questions or
concerns about the deprecation of features in any Ory product.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Ory is committed to maintaining a high level of quality and performance in our products, and deprecating features is a rare but
necessary step to ensure that we can continue to innovate and improve our offerings. We understand that deprecations can be
disruptive, and we strive to provide clear communication and ample time for users to adapt to changes. We encourage users to
review the deprecation information provided in this section and to reach out to our support channels if they have any questions or
concerns about the deprecation of features in any Ory product.

IMO we can cut this section. It doesn't really add anything other than apologies.

Comment on lines +7 to +10
This section lists all behavior that has been deprecated in Ory Kratos. It is recommended to check this section regularly to stay
up-to-date with the latest changes and to avoid relying on deprecated functionality in your implementation. While Ory Kratos is
designed to be backward compatible, some improvements require changes to the underlying implementation, which may lead to the
deprecation of certain functionality.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This section lists all behavior that has been deprecated in Ory Kratos. It is recommended to check this section regularly to stay
up-to-date with the latest changes and to avoid relying on deprecated functionality in your implementation. While Ory Kratos is
designed to be backward compatible, some improvements require changes to the underlying implementation, which may lead to the
deprecation of certain functionality.
This section lists deprecated behavior in Ory Kratos. Check this section regularly to avoid relying on deprecated functionality.

Comment on lines +3 to +4
title: Feature Deprecations
sidebar_label: Feature Deprecations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Feature Deprecations
sidebar_label: Feature Deprecations
title: Feature deprecations
sidebar_label: Feature deprecations

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.

## Staying Informed
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Staying Informed
## Stay informed


### Admin session extension API (`faster_session_extend`)

**Who is impacted by this change?**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Who is impacted by this change?**
- Who is impacted by this change?

extend their users' sessions. The new implementation may result in faster response times and improved performance when extending
sessions.

**Why was this change made?**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Why was this change made?**
- Why was this change made?

extension from the retrieval of the updated session information, we can reduce the processing time and resource usage for
extending sessions, especially in scenarios with high traffic or large session data.

**How to adapt to this change?**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**How to adapt to this change?**
- How to adapt to this change?

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.

2 participants