Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Partition old configuration into deprecation/legacy #906

Merged
merged 2 commits into from
Nov 9, 2023

Conversation

dominikschubert
Copy link
Member

Introduces a new partitioning of older configuration values to unify how we communicate their deprecation status.

  1. Deprecated ... Still supported in latest version but should not be used anymore. Will be removed in one of the next major releases.
  2. Legacy ... Has been removed in a previous major release. Does NOT affect the latest version anymore.

Follow-up

We should probably also cover variables we've just removed from the list in the past.

This isn't super urgent but we should make sure we sync the deprecation status here with the ones we're tracking in localstack.

@dominikschubert dominikschubert self-assigned this Nov 9, 2023
Copy link

github-actions bot commented Nov 9, 2023

🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-906.surge.sh 🎊

Copy link
Member

@joe4dev joe4dev left a comment

Choose a reason for hiding this comment

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

Great initiative 🚀 . I like the separation and metadata about when it was removed.

Improved configuration handling and communication is something we should tackle 📈

Two discussion points:

  1. How long should we keep the legacy variables at all? one extra major release, forever?
  2. How do we go about adding the deprecation flag inline (i.e., within the subsection) vs. globally?

For Lambda, we still have the migration guide but I'm also fine with re-adding them for configuration discoverability at one page, if labelled clearly.

@joe4dev
Copy link
Member

joe4dev commented Nov 9, 2023

The most urgent thing is probably to synchronize the list with deprecations.py and what we actually remove in 3.0 🧙

@dominikschubert
Copy link
Member Author

The most urgent thing is probably to synchronize the list with deprecations.py and what we actually remove in 3.0 🧙

I wouldn't call it urgent, but yeah definitely want to have this synced until next week!
Basically I'd like to introduce the same terminology there as well.

@dominikschubert
Copy link
Member Author

dominikschubert commented Nov 9, 2023

How long should we keep the legacy variables at all? one extra major release, forever?

Yes that was our thinking. At least forever mentioning that they once existed.

How do we go about adding the deprecation flag inline (i.e., within the subsection) vs. globally?

It's probably not needed anymore to have it inline, I'll remove this in a follow-up when adding more items

@dominikschubert dominikschubert mentioned this pull request Nov 9, 2023
15 tasks
@dominikschubert dominikschubert merged commit 164b851 into release/v3.0 Nov 9, 2023
@dominikschubert dominikschubert deleted the v3-cleanup branch November 9, 2023 15:57
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants