mmyrte commented on PR #25935: URL: https://github.com/apache/superset/pull/25935#issuecomment-1874033356
For me, the confusion starts with the title of the page - doesn't "Installing From Scratch" usually mean installing from source? 1. Is it intended that by the end of the tutorial, I have a **minimally configured best-practice production install**? I cannot run any `superset cmd` without setting a secret key, which is being described as only necessary for production. https://github.com/apache/superset/blob/29633e7d8cad7b52669a9e6f5e064cd34da803a3/docs/docs/installation/installing-superset-from-scratch.mdx#L132-L134 2. Is it intended that I get an **installation for debugging**? I'm being told to use `superset run --debugger`. https://github.com/apache/superset/blob/29633e7d8cad7b52669a9e6f5e064cd34da803a3/docs/docs/installation/installing-superset-from-scratch.mdx#L155-L156 3. Is it intended that I **clone the repo** and build my own TS/JS/CSS assets, given that I'm being told to cd into a folder that doesn't exist after `pip install apache-superset`? https://github.com/apache/superset/blob/29633e7d8cad7b52669a9e6f5e064cd34da803a3/docs/docs/installation/installing-superset-from-scratch.mdx#L149-L153 From my experience, I expect pages titled `Install [XY]` to be linear tutorials with a minimum of branches, leaving me with a minimally configured installation according to best practices. In this case, I suppose that would mean something like the following structure: - Install from PyPI - Disclaimer: Where production needs deviate from localhost/testing needs, the relevant docs will be linked to. - Disclaimer: We default to `pip` and `python`, but be aware that your OS might use `pip3` and `python3` - OS Dependencies - Check that these are actually needed! e.g. Postgres is listed for macOS but not actually relevant for a minimal sqlite based install. - Virtual Environment Setup - Create - Activate - `pip install apache-superset` - Mention that additional dependencies come into play for prod, like DBs, their drivers, WSGI servers, proxies... - Minimally Configuring Superset - Find `$PYTHONPATH` `python -c "import sys; print('\n'.join(sys.path))"` - Put `superset_config.py` on pythonpath - set `SECRET_KEY` - set listening address - set port - Mention <https://superset.apache.org/docs/installation/configuring-superset> - Initializing Superset - `superset db upgrade` - `superset fab create-admin` - `superset init` - Running as test instance - `superset run` - ~Installing Superset with Helm in Kubernetes~ <- should be removed since there's now [Installing on Kubernetes](https://superset.apache.org/docs/installation/running-on-kubernetes) Like @SLE-TheRealOne, I would be happy to support either @lgharibpmu or @john-bodley in writing or testing a revamped tutorial on a vanilla macOS or Linux installation. God knows I appreciate the work everyone's done on this project - but I have a hard time getting started, and that's just not ideal. While I am not a project member who could initiate a more high-level discussion about what-goes-where, à la <https://diataxis.fr/>, I am super happy to lend my outsider's eyes for feedback. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
