(superset) 01/01: docs: simplify the Quickstart guide

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

maximebeauchemin pushed a commit to branch docs_quickstart
in repository https://gitbox.apache.org/repos/asf/superset.git

commit adb49c24e6e2ffe399172a29e2ca51c95473806a
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Thu Mar 21 14:36:51 2024 -0700

    docs: simplify the Quickstart guide
    
    For a true quickstart, let's direct people towards `docker-compose`
    where they can get a multi-container instance setup with 2 shell
    commands.
    
    The current docker setup is limited and forces the user to run
    an extra set of commands to load examples, create a user, ...
    and they end up in a slower single-container instance.
    
    On docker compose, we have all this setup as well as the pointer
    to the latest release by default.
---
 docs/docs/quickstart.mdx | 82 +++++++++++++++++++-----------------------------
 1 file changed, 33 insertions(+), 49 deletions(-)

diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
index 0b02800739..71a4f5fd79 100644
--- a/docs/docs/quickstart.mdx
+++ b/docs/docs/quickstart.mdx
@@ -4,61 +4,38 @@ hide_title: false
 sidebar_position: 2
 ---
 
-**Ready to give Apache Superset a try?** This quickstart will help you run Superset on your local machine in
-**5 simple steps**. It assumes that you have [Docker](https://www.docker.com) installed.
+**Ready to give Apache Superset a try?** This quickstart guide will help you
+get up and running on your local machine in **5 simple steps**. Note that
+it assumes that you have [Docker](https://www.docker.com),
+[docker-compose](https://docs.docker.com/compose/), and
+[git](https://git-scm.com/) installed.
 
-### 1. Get Superset
-To get started, set the `SUPERSET_VERSION` environment variable with the latest Superset version.
-[Click here](https://github.com/apache/superset/releases) to check the latest version.
-
-```
-$ export SUPERSET_VERSION=<latest_version>
-```
-
-Pull the Superset image from Docker Hub:
+:::caution
+While we recommend using `docker-compose` for a quick start in a sandbox-type
+environment and for other development-type use cases, we
+do not recommend this setup for production. For this purpose please
+refer to our
+[Installing on Kubernetes](/docs/installation/running-on-kubernetes/)
+page.
+:::
 
-```
-$ docker pull apache/superset:$SUPERSET_VERSION
-```
+### 1. Get Superset
 
-### 2. Start Superset
-:::tip
-Note that some configuration is mandatory for Superset in order to start. In particular, Superset will not start without
-a user-specified value of `SECRET_KEY` in a Superset configuration file or `SUPERSET_SECRET_KEY` as an environment variable.
-Please see [Configuring Superset](/docs/installation/configuring-superset/) for more details.
-:::
-```
-$ docker run -d -p 8080:8088 \
-             -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" \
-             -e "TALISMAN_ENABLED=False" \
-             --name superset apache/superset:$SUPERSET_VERSION
+```bash
+$ git clone git@github.com:apache/superset.git
 ```
 
-### 3. Create an account
-```
-$ docker exec -it superset superset fab create-admin \
-              --username admin \
-              --firstname Admin \
-              --lastname Admin \
-              --email admin@localhost \
-              --password admin
-```
+### 2. Start the latest official release of Superset
 
-### 4. Configure Superset
 ```
-$ docker exec -it superset superset db upgrade &&
-         docker exec -it superset superset load_examples &&
-         docker exec -it superset superset init
+$ docker-compose -f docker-compose-image-tag.yml up
 ```
-:::tip
-This step can take some time. While you wait, feel free to join the official Slack channel to check for new releases,
-ask questions, and engage with the community.
-[Click here to join.](http://bit.ly/join-superset-slack)
-:::
+This may take a moment as docker-compose will fetch the underlying
+docker images and will load up some examples. Once all containers
+are downloaded and the output settles, you're ready to log in.
 
-### 5. Start using Superset
-After configuring your fresh instance, head over to [http://localhost:8080](http://localhost:8080) and
-log in with the default created account:
+### 3. Start using Superset
+Now head over to [http://localhost:8080](http://localhost:8080) and log in with the default created account:
 ```
 username: admin
 password: admin
@@ -69,7 +46,7 @@ password: admin
 ### Wrapping Up
 Once you're done with Superset, you can stop and remove it just like any other container:
 ```
-$ docker container rm -f superset
+$ docker-compose down
 ```
 :::tip
 You can use the same container more than once, as Superset will persist data locally. However, make sure to properly stop all
@@ -81,6 +58,13 @@ processes by running Docker `stop` command. By doing so, you can avoid data corr
 From this point on, you can head on to:
 - [Create your first Dashboard](/docs/creating-charts-dashboards/creating-your-first-dashboard)
 - [Connect to a Database](/docs/databases/installing-database-drivers)
-- [Configure Superset](/docs/installation/configuring-superset/)
+- [Using Docker Compose](/docs/installation/installing-superset-using-docker-compose): find
+  out more about how to install docker & docker-compose, how to point to different Superset
+  version, or how to set up your development environment.
+- [Configure Superset](/docs/installation/configuring-superset/): Superset is highly configurable.
+  Find out what the options are here.
+- [Installing on Kubernetes](/docs/installation/running-on-kubernetes/): if you'd like to setup
+  Superset in a production environment, we recommend using [Kubernetes](https://kubernetes.io/)
+  and our official [Helm Chart](https://github.com/apache/superset/tree/master/helm/superset).
 
-Or just explore our Documentation!
+Or just explore our [Documentation](https://superset.apache.org/docs/intro)!