Qbeast user documentation update #552
Description
This issue was auto-created as part of the Zenhub sub-issues migration. The original entity was opened on 2024-05-22. For more details see this post.
we already have some documentation pages written that can be helpful for those who want to learn more about the core of Qbeast or try Qbeast Spark implementation for their project.
after a review with Paola, these pages require a deeper exploration and an update:
- OTreeAlgorithm. The content is ok since it’s a dedicated page to the base indexing algorithm and structure, but maybe some graphics could be updated.
- Advanced Configuration. Check the document and understand if needs to be updated or include detailed explanations.
- FAQ should behave as a Troubleshooting guide. Right now is very poor in content, and should be a source of truth for users who want to test a Qbeast library.
- Cloud Storage. This document should be decomposed for AWS, Azure, and GCP.
- ColumnsToIndexSelector should be called AutoIndexer.
More guides/extra thoughts:
- Databricks and Snowflake integration (same as AWS, Azure, and GCP pages)
- Check better links between pages (make sure everything follows a storyline).
- Also, revisit the way the Cube is presented. Is not a well-known concept, and is hard to imagine. Better to use “space”, “files”…