From 7367a945813359fd6dba6aad4ae873ad94facd8d Mon Sep 17 00:00:00 2001 From: artofcomputing Date: Mon, 20 Nov 2023 21:30:16 -0300 Subject: [PATCH 1/8] create quickstart page & organize pages --- docs/docs/api.mdx | 2 +- docs/docs/contributing/_category_.json | 2 +- docs/docs/databases/_category_.json | 2 +- docs/docs/frequently-asked-questions.mdx | 2 +- docs/docs/installation/_category_.json | 2 +- docs/docs/miscellaneous/_category_.json | 2 +- docs/docs/quickstart.mdx | 56 ++++++++++++++++++++++++ docs/docs/security/_category_.json | 2 +- 8 files changed, 63 insertions(+), 7 deletions(-) create mode 100644 docs/docs/quickstart.mdx diff --git a/docs/docs/api.mdx b/docs/docs/api.mdx index fb3572eb376f..3e9b95f763da 100644 --- a/docs/docs/api.mdx +++ b/docs/docs/api.mdx @@ -1,7 +1,7 @@ --- title: API hide_title: true -sidebar_position: 9 +sidebar_position: 10 --- import { Buffer } from 'buffer'; diff --git a/docs/docs/contributing/_category_.json b/docs/docs/contributing/_category_.json index ca96e44a2dcd..6e985832541b 100644 --- a/docs/docs/contributing/_category_.json +++ b/docs/docs/contributing/_category_.json @@ -1,4 +1,4 @@ { "label": "Contributing", - "position": 6 + "position": 7 } diff --git a/docs/docs/databases/_category_.json b/docs/docs/databases/_category_.json index de1c640183f6..7c9f05f8565a 100644 --- a/docs/docs/databases/_category_.json +++ b/docs/docs/databases/_category_.json @@ -1,4 +1,4 @@ { "label": "Connecting to Databases", - "position": 3 + "position": 5 } diff --git a/docs/docs/frequently-asked-questions.mdx b/docs/docs/frequently-asked-questions.mdx index df4ee7a44251..11682136d78c 100644 --- a/docs/docs/frequently-asked-questions.mdx +++ b/docs/docs/frequently-asked-questions.mdx @@ -1,7 +1,7 @@ --- title: Frequently Asked Questions hide_title: true -sidebar_position: 7 +sidebar_position: 8 --- ## Frequently Asked Questions diff --git a/docs/docs/installation/_category_.json b/docs/docs/installation/_category_.json index 0a1b013d88e8..096f63b1ef17 100644 --- a/docs/docs/installation/_category_.json +++ b/docs/docs/installation/_category_.json @@ -1,4 +1,4 @@ { "label": "Installation and Configuration", - "position": 2 + "position": 3 } diff --git a/docs/docs/miscellaneous/_category_.json b/docs/docs/miscellaneous/_category_.json index f6f2299e95ad..16bf78ed5ccc 100644 --- a/docs/docs/miscellaneous/_category_.json +++ b/docs/docs/miscellaneous/_category_.json @@ -1,4 +1,4 @@ { "label": "Miscellaneous", - "position": 5 + "position": 6 } diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx new file mode 100644 index 000000000000..8c0c952222cb --- /dev/null +++ b/docs/docs/quickstart.mdx @@ -0,0 +1,56 @@ +--- +title: Quickstart +hide_title: true +sidebar_position: 2 +--- + +## Quickstart + +You’ll need to have Docker or similar software installed on your computer to follow this quickstart. + +### Get Apache Superset using Docker +``` +$ docker pull apache/superset:latest +``` + +### Start a Superset instance +``` +$ docker run -d -p 8080:8088 -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" --name superset apache/superset +``` + +### Create an account for the instance +``` +$ docker exec -it superset superset fab create-admin \ + --username admin \ + --firstname Superset \ + --lastname Admin \ + --email admin@superset.apache.org \ + --password admin +``` + +### Update the instance database +``` +$ docker exec -it superset superset db upgrade +``` + +### Load fresh examples +``` +$ docker exec -it superset superset load_examples +``` + +### Configure the default roles +``` +$ docker exec -it superset superset init +``` + +### Log in and start using Superset +To access your fresh Superset instance, head over to [http://localhost:8088](http://localhost:8088) +log in with the default username and password: +``` +username: admin +password: admin +``` + +## What's next? + +From this point, you can head on to Create your first Dashboard, Connect to a Database, or explore our Documentation. \ No newline at end of file diff --git a/docs/docs/security/_category_.json b/docs/docs/security/_category_.json index 7d24a44873bc..d88d7e53bb19 100644 --- a/docs/docs/security/_category_.json +++ b/docs/docs/security/_category_.json @@ -1,4 +1,4 @@ { "label": "Security", - "position": 10 + "position": 9 } From bd12e061e2988d2e41f1771c49c17b96d596e231 Mon Sep 17 00:00:00 2001 From: artofcomputing Date: Tue, 21 Nov 2023 15:02:22 -0300 Subject: [PATCH 2/8] organize quickstart page --- docs/docs/quickstart.mdx | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 8c0c952222cb..78316cf17763 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -1,24 +1,23 @@ --- title: Quickstart -hide_title: true +hide_title: false sidebar_position: 2 --- -## Quickstart +**Ready to give Apache Superset a try?** This quickstart will help you run Superset on your local machine. +It assumes that you have [Docker](https://www.docker.com) or similar software installed. -You’ll need to have Docker or similar software installed on your computer to follow this quickstart. - -### Get Apache Superset using Docker +### 1. Get Superset ``` -$ docker pull apache/superset:latest +$ docker pull apache/superset:3.0.1 ``` -### Start a Superset instance +### 2. Start Superset ``` -$ docker run -d -p 8080:8088 -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" --name superset apache/superset +$ docker run -d -p 8080:8088 -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" --name superset apache/superset:3.0.1 ``` -### Create an account for the instance +### 3. Create an account ``` $ docker exec -it superset superset fab create-admin \ --username admin \ @@ -28,29 +27,36 @@ $ docker exec -it superset superset fab create-admin \ --password admin ``` -### Update the instance database +### 4. Update the database ``` $ docker exec -it superset superset db upgrade ``` -### Load fresh examples +### 5. Load fresh examples ``` $ docker exec -it superset superset load_examples ``` -### Configure the default roles +### 6. Configure security roles ``` $ docker exec -it superset superset init ``` -### Log in and start using Superset -To access your fresh Superset instance, head over to [http://localhost:8088](http://localhost:8088) +### 7. Start using Superset +To access your fresh Superset instance, head over to [http://localhost:8088](http://localhost:8088) and log in with the default username and password: ``` username: admin password: admin ``` +#### 🎉 Congratulations! Superset is now up and running on your machine 🎉 + + ## What's next? -From this point, you can head on to Create your first Dashboard, Connect to a Database, or explore our Documentation. \ No newline at end of file +From this point, you can head on to: +- [Create your first Dashboard](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard) +- [Connect to a Database](https://superset.apache.org/docs/databases/installing-database-drivers) + +Or just explore our Documentation! \ No newline at end of file From 43183c16dc35ee882e02b84c8a8255449fb39781 Mon Sep 17 00:00:00 2001 From: artofcomputing Date: Wed, 22 Nov 2023 21:06:08 -0300 Subject: [PATCH 3/8] updates container version --- docs/docs/quickstart.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 78316cf17763..5ed6e326420a 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -5,16 +5,16 @@ sidebar_position: 2 --- **Ready to give Apache Superset a try?** This quickstart will help you run Superset on your local machine. -It assumes that you have [Docker](https://www.docker.com) or similar software installed. +It assumes that you have [Docker](https://www.docker.com) installed. ### 1. Get Superset ``` -$ docker pull apache/superset:3.0.1 +$ docker pull apache/superset:3.0.2 ``` ### 2. Start Superset ``` -$ docker run -d -p 8080:8088 -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" --name superset apache/superset:3.0.1 +$ docker run -d -p 8080:8088 -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" --name superset apache/superset:3.0.2 ``` ### 3. Create an account @@ -44,7 +44,7 @@ $ docker exec -it superset superset init ### 7. Start using Superset To access your fresh Superset instance, head over to [http://localhost:8088](http://localhost:8088) and -log in with the default username and password: +log in with the default created account: ``` username: admin password: admin From c6d49003d60dfa4dcc3efd0da06a32d08dccb41d Mon Sep 17 00:00:00 2001 From: artofcomputing Date: Thu, 23 Nov 2023 17:46:41 -0300 Subject: [PATCH 4/8] organize quickstart structure and add tips --- docs/docs/quickstart.mdx | 46 ++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 5ed6e326420a..3fb0f5322592 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -4,7 +4,7 @@ hide_title: false sidebar_position: 2 --- -**Ready to give Apache Superset a try?** This quickstart will help you run Superset on your local machine. +**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. ### 1. Get Superset @@ -14,49 +14,53 @@ $ docker pull apache/superset:3.0.2 ### 2. Start Superset ``` -$ docker run -d -p 8080:8088 -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" --name superset apache/superset:3.0.2 +$ docker run -d -p 8080:8088 \ + -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" \ + -e "TALISMAN_ENABLED=False" \ + --name superset apache/superset:3.0.2 ``` +:::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](https://superset.apache.org/docs/installation/configuring-superset/) for more details. +::: ### 3. Create an account ``` $ docker exec -it superset superset fab create-admin \ --username admin \ - --firstname Superset \ + --firstname Admin \ --lastname Admin \ - --email admin@superset.apache.org \ + --email admin@localhost \ --password admin ``` -### 4. Update the database +### 4. Configure Superset ``` -$ docker exec -it superset superset db upgrade +$ docker exec -it superset superset db upgrade && + docker exec -it superset superset load_examples && + docker exec -it superset superset init ``` +:::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.](https://apache-superset.slack.com/join/shared_invite/zt-26ol9ge4y-kzUnSo9inRepOay0ufBTsA#/shared-invite/email) +::: -### 5. Load fresh examples -``` -$ docker exec -it superset superset load_examples -``` - -### 6. Configure security roles -``` -$ docker exec -it superset superset init -``` - -### 7. Start using Superset -To access your fresh Superset instance, head over to [http://localhost:8088](http://localhost:8088) and +### 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: ``` username: admin password: admin ``` -#### 🎉 Congratulations! Superset is now up and running on your machine 🎉 - +#### 🎉 Congratulations! Superset is now up and running on your machine! 🎉 ## What's next? -From this point, you can head on to: +From this point on, you can head on to: - [Create your first Dashboard](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard) - [Connect to a Database](https://superset.apache.org/docs/databases/installing-database-drivers) +- [Configure Superset](https://superset.apache.org/docs/installation/configuring-superset/) Or just explore our Documentation! \ No newline at end of file From b117068523afc03837ba25f965e07a082e0a080e Mon Sep 17 00:00:00 2001 From: Braum Date: Wed, 29 Nov 2023 08:45:03 -0300 Subject: [PATCH 5/8] add wrapping up --- docs/docs/quickstart.mdx | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 3fb0f5322592..0b3fadea4b12 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -56,6 +56,16 @@ password: admin #### 🎉 Congratulations! Superset is now up and running on your machine! 🎉 +### Wrapping Up +Once you're done with Superset, you can stop and remove it just like any other container: +``` +$ docker container rm -f superset +``` +:::tip +You can use the same container more than once, as Superset will persist data locally. However, make sure to properly stop all processes by running Docker +`stop` command. By doing so, you can avoid data corruption and/or loss of data. +::: + ## What's next? From this point on, you can head on to: @@ -63,4 +73,4 @@ From this point on, you can head on to: - [Connect to a Database](https://superset.apache.org/docs/databases/installing-database-drivers) - [Configure Superset](https://superset.apache.org/docs/installation/configuring-superset/) -Or just explore our Documentation! \ No newline at end of file +Or just explore our Documentation! From 328e8715016a5a5871a412dc6c6a4c703b18c9d2 Mon Sep 17 00:00:00 2001 From: Braum Date: Thu, 30 Nov 2023 16:15:09 -0300 Subject: [PATCH 6/8] modifies container tag --- docs/docs/quickstart.mdx | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 0b3fadea4b12..c7b58e33d27b 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -8,20 +8,26 @@ sidebar_position: 2 It assumes that you have [Docker](https://www.docker.com) installed. ### 1. Get Superset +To get started, add the latest Superset version in the `SUPERSET_VERSION` environment variable, and pull the container from Docker Hub: ``` -$ docker pull apache/superset:3.0.2 +$ export SUPERSET_VERSION=""; + docker pull apache/superset:$SUPERSET_VERSION ``` +:::tip +Not sure what the latest stable Superset version is? [Click here](https://github.com/apache/superset/releases) to check our release page +for up-to-date information. +::: ### 2. Start Superset ``` $ docker run -d -p 8080:8088 \ -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" \ -e "TALISMAN_ENABLED=False" \ - --name superset apache/superset:3.0.2 + --name superset apache/superset:$SUPERSET_VERSION ``` :::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. +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](https://superset.apache.org/docs/installation/configuring-superset/) for more details. ::: @@ -62,8 +68,8 @@ Once you're done with Superset, you can stop and remove it just like any other c $ docker container rm -f superset ``` :::tip -You can use the same container more than once, as Superset will persist data locally. However, make sure to properly stop all processes by running Docker -`stop` command. By doing so, you can avoid data corruption and/or loss of data. +You can use the same container more than once, as Superset will persist data locally. However, make sure to properly stop all +processes by running Docker `stop` command. By doing so, you can avoid data corruption and/or loss of data. ::: ## What's next? From 8ff370e8179a2551ed18cf7db5fdc81657242193 Mon Sep 17 00:00:00 2001 From: artofcomputing Date: Fri, 1 Dec 2023 10:31:17 -0300 Subject: [PATCH 7/8] review first step --- docs/docs/quickstart.mdx | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index c7b58e33d27b..15cfd8f498e5 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -4,19 +4,22 @@ 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 will help you run Superset on your local machine in +**5 simple steps**. It assumes that you have [Docker](https://www.docker.com) installed. ### 1. Get Superset -To get started, add the latest Superset version in the `SUPERSET_VERSION` environment variable, and pull the container from Docker Hub: +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=""; - docker pull apache/superset:$SUPERSET_VERSION +$ export SUPERSET_VERSION= +``` + +Pull the Superset image from Docker Hub: + +``` +$ docker pull apache/superset:$SUPERSET_VERSION ``` -:::tip -Not sure what the latest stable Superset version is? [Click here](https://github.com/apache/superset/releases) to check our release page -for up-to-date information. -::: ### 2. Start Superset ``` @@ -49,7 +52,8 @@ $ docker exec -it superset superset db upgrade && ``` :::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.](https://apache-superset.slack.com/join/shared_invite/zt-26ol9ge4y-kzUnSo9inRepOay0ufBTsA#/shared-invite/email) +ask questions, and engage with the community. +[Click here to join.](https://apache-superset.slack.com/join/shared_invite/zt-26ol9ge4y-kzUnSo9inRepOay0ufBTsA#/shared-invite/email) ::: ### 5. Start using Superset From 229bf700e80ab2d49d49b4eaecfeea8ee3415c20 Mon Sep 17 00:00:00 2001 From: artofcomputing Date: Fri, 1 Dec 2023 10:35:04 -0300 Subject: [PATCH 8/8] review step two tip --- docs/docs/quickstart.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 15cfd8f498e5..115f04929c0f 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -22,17 +22,17 @@ $ docker pull apache/superset:$SUPERSET_VERSION ``` ### 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](https://superset.apache.org/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 ``` -:::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](https://superset.apache.org/docs/installation/configuring-superset/) for more details. -::: ### 3. Create an account ```