search

apache / superset

Apache Superset is a Data Visualization and Data Exploration Platform
https://superset.apache.org/
Apache License 2.0
62.8k stars 13.87k forks source link

docs: make it more clear that GLOBAL_ASYNC_QUERIES is experimental/beta #30770

Closed mistercrunch closed 1 week ago

mistercrunch commented 2 weeks ago

Not sure if we're all aligned on this, but I've seen confusion around GLOBAL_ASYNC_QUERIES and the reality is we shouldn't recommend flipping this on until we iron out at least a few things. This comment I'm adding makes it a bit more clear you should steer away unless you know what you're doing

michael-s-molina commented 2 weeks ago

Maybe it would be interesting to have link to FEATURE_FLAGS.md at the top of FEATURE_FLAGS section.

mistercrunch commented 2 weeks ago

Agreed, though I hate having fragmented information about flags in config.py and in FEATURE_FLAGS.md, we should migrate/merge all intel in one place and reference it from others.

Maybe the larger task here is to merge what's in config.py onto FEATURE_FLAGS.md, clean it up and reference it from config.py?

michael-s-molina commented 2 weeks ago

@rusackas and @sadpandajoe had some ideas on how to improve this. I agree with the idea of keeping things in just one place.

sadpandajoe commented 2 weeks ago

Agree on having a single source of truth. I think the other problem right now is that the config file with comments is huge so i'd vote to moving it to the .md file. One thing I was thinking about is just sectioning things like we do in the feature flag file, might be a bit more work, but then we don't have to comment as much as which ones are stable, which ones are testing and so on.

mistercrunch commented 1 week ago

Hey can we merge this as is, and defer to another task/issue of merging the content/comments in config.py into FEATURE_FLAGS.md?

sadpandajoe commented 1 week ago

Hey can we merge this as is, and defer to another task/issue of merging the content/comments in config.py into FEATURE_FLAGS.md?

@mistercrunch yeah, these would be follow-ups and not a blocker for this PR