Skip to content

Add doc for behavior change configuration#3677

Merged
MonkeyCanCode merged 1 commit intoapache:mainfrom
MonkeyCanCode:doc_for_behavior_change_configuration
Feb 7, 2026
Merged

Add doc for behavior change configuration#3677
MonkeyCanCode merged 1 commit intoapache:mainfrom
MonkeyCanCode:doc_for_behavior_change_configuration

Conversation

@MonkeyCanCode
Copy link
Contributor

We are missing doc for https://github.com/apache/polaris/blob/main/polaris-core/src/main/java/org/apache/polaris/core/config/BehaviorChangeConfiguration.java.

Checklist

  • 🛡️ Don't disclose security issues! (contact security@apache.org)
  • 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
  • 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
  • 💡 Added comments for complex logic
  • 🧾 Updated CHANGELOG.md (if needed)
  • 📚 Updated documentation in site/content/in-dev/unreleased (if needed)

@adutra
Copy link
Contributor

adutra commented Feb 5, 2026

Hi @MonkeyCanCode I'm not sure the "behavior change" flags were meant to be exposed publicly. Their javadocs say:

Internal configuration flags for non-feature behavior changes in Polaris. These flags control subtle behavior adjustments and bug fixes, not user-facing settings. They are intended for internal use only, are inherently unstable, and may be removed at any time. When introducing a new flag, consider the trade-off between maintenance burden and the risk of an unguarded behavior change. Flags here are generally short-lived and should either be removed or promoted to stable feature flags before the next release.

Of course... those flags have been there for a long time now and were neither removed nor promoted to stable flags 😄

Therefore, I'm not sure we should expose them in documentation – at least not before assessing if they should be removed or promoted.

Wdyt?

@MonkeyCanCode
Copy link
Contributor Author

Hi @MonkeyCanCode I'm not sure the "behavior change" flags were meant to be exposed publicly. Their javadocs say:

Internal configuration flags for non-feature behavior changes in Polaris. These flags control subtle behavior adjustments and bug fixes, not user-facing settings. They are intended for internal use only, are inherently unstable, and may be removed at any time. When introducing a new flag, consider the trade-off between maintenance burden and the risk of an unguarded behavior change. Flags here are generally short-lived and should either be removed or promoted to stable feature flags before the next release.

Of course... those flags have been there for a long time now and were neither removed nor promoted to stable flags 😄

Therefore, I'm not sure we should expose them in documentation – at least not before assessing if they should be removed or promoted.

Wdyt?

Got it. Yeah, I was working on something and had to use one of them then noticed none of these are documented. Will start a ML for it. Thanks for the quick review @adutra.

@adutra
Copy link
Contributor

adutra commented Feb 5, 2026

An ML discussion thread would be perfect, thanks!

@MonkeyCanCode
Copy link
Contributor Author

those flags have been there for a long time now and were neither removed nor promoted to stable flags

Thanks for review @adutra . ML: https://lists.apache.org/thread/8fgszl9jw9718dstlh3dxn0o1g8wkrh4

Copy link
Contributor

@flyrain flyrain left a comment

Choose a reason for hiding this comment

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

I'm OK to add them in the doc. Most of them are user-facing config indeed.

@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Feb 7, 2026
@MonkeyCanCode MonkeyCanCode merged commit 2eed885 into apache:main Feb 7, 2026
15 checks passed
@github-project-automation github-project-automation bot moved this from Ready to merge to Done in Basic Kanban Board Feb 7, 2026
@MonkeyCanCode
Copy link
Contributor Author

Merged as concluded on the ML. We will clean up risky ones in a diff PR.

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.

3 participants