docs(caching): Restructure and improve caching docs #22687
Conversation
docs/docs/installation/cache.mdx
Outdated
| For chart data, Superset goes up a “timeout search path”, from the chart's configuration | ||
| to the dataset’s, the database’s, then ultimately falls back to the global default | ||
| defined in `DATA_CACHE_CONFIG`. |
There was a problem hiding this comment.
I really have no idea what this means and I wouldn't guess most first-time users would either. I maintained it because it was in the existing docs, but I think it's either in need of further clarification by someone who understands it or should be removed.
There was a problem hiding this comment.
@reidab what this is trying to convey is the fact that you can override the cache timeout in the chart, dataset and database (checked in that order), and if none of those is defined, it will use the default cache timeout defined in the cache config.
There was a problem hiding this comment.
@villebro Thanks! That helps to clarify it. I hadn't understood that this was referring to just the timeout, but it makes sense now. I rewrote it a bit to be more explicit.
There was a problem hiding this comment.
@reidab awesome, thanks for helping clarify this!
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️
We hope to see you in our Slack community too!
mistercrunch
added
🏷️ bot
SUMMARY
Improves caching documentation. This PR attempts to reorder and rewrite existing caching documentation for improved clarity.
Specifically:
RESULTS_BACKENDinto its own section and clarifying that it is not configured using a flask-caching dictionary.SupersetMetastoreCacheinto its own section.TESTING INSTRUCTIONS
Read the new docs! Do the accurately describe cache configuration in a clear manner?
ADDITIONAL INFORMATION