rusackas commented on code in PR #28285: URL: https://github.com/apache/superset/pull/28285#discussion_r1587717665
########## docs/docs/configuration/async-queries-celery.mdx: ########## @@ -5,9 +5,9 @@ sidebar_position: 4 version: 1 --- -## Async Queries via Celery +# Async Queries via Celery Review Comment: Wait, what's all this, then? _Consistency_? 🤩 ########## docs/docs/configuration/configuring-superset.mdx: ########## @@ -5,28 +5,40 @@ sidebar_position: 1 version: 1 --- -## Configuring Superset +# Configuring Superset -### Configuration +## superset_config.py -To configure your application, you need to create a file `superset_config.py`. Add this file to your +Superset exposes hundreds of configurable parameters through its Review Comment: Random aside, but I wonder if this should be brought up as a fever dream on the User Preferences SIP: Once we HAVE a User Preferences UI, we could _probably_ expose/document much of this config for admin users, and have any changes restart the server as needed. Some things (secrets, etc) might not have business there, but plenty of other things might be nice. ########## README.md: ########## @@ -77,19 +81,19 @@ https://superset.staged.apache.org/superset-video-4k.mp4 **Large Gallery of Visualizations** -<kbd><img title="Gallery" src="superset-frontend/src/assets/images/screenshots/gallery.jpg"/></kbd><br/> +<kbd><img title="Gallery" src="https://raw.githubusercontent.com/apache/superset/master/superset-frontend/src/assets/images/screenshots/gallery.jpg"/></kbd><br/> Review Comment: I think we're not supposed to use githubusercontent. We can move these to the `lfs` branch on `superset-site` now so that they're served from [https://superset.staged.apache.org/](https://superset.staged.apache.org/) To make that even smoother, we could leave those files in _this_ repo on `git-lfs` like you did before, and have a GH action that moves them to `superset-site`'s `lfs` branch automagically. For now, I'm happy to port the files over manually and update these URLs for ya if you'd like. ########## docs/docs/configuration/configuring-superset.mdx: ########## @@ -139,10 +161,17 @@ Use the following database drivers and connection strings: | [PostgreSQL](https://www.postgresql.org/) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` | | [MySQL](https://www.mysql.com/) | `pip install mysqlclient` | `mysql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` | +:::tip +Properly setting up metadata store is beyond the scope of this documentation. We recommend +using a hosted managed service such as [Amazon RDS](https://aws.amazon.com/rds/) or +[Google Cloud Databases](https://cloud.google.com/products/databases?hl=en) to handle +service and supporting infrastructure and backup strategy. +::: + Review Comment: I'm not sure we need all the linebreaks... is this your IDE adding these? ########## docs/docs/configuration/configuring-superset.mdx: ########## @@ -5,28 +5,40 @@ sidebar_position: 1 version: 1 --- -## Configuring Superset +# Configuring Superset -### Configuration +## superset_config.py -To configure your application, you need to create a file `superset_config.py`. Add this file to your +Superset exposes hundreds of configurable parameters through its +[config.py module](https://github.com/apache/superset/blob/master/superset/config.py). The +variables and objects exposed act as a public interface of the bulk of what you may want +to configure, alter and interface with. In this python module, you'll find all these Review Comment: ```suggestion to configure, alter, and interface with. In this python module, you'll find all these ``` I ❤️ Oxford commas ########## docs/docs/installation/docker-compose.mdx: ########## @@ -5,23 +5,29 @@ sidebar_position: 3 version: 1 --- -## Using Docker Compose +import useBaseUrl from "@docusaurus/useBaseUrl"; -**DO NOT USE THIS FOR PRODUCTION!** +# Using Docker Compose -The fastest way to try Superset locally is using Docker Compose on a Linux or Mac OSX -computer. Superset does not have official support for Windows. It's also the easiest -way to launch a fully functioning **development environment** quickly. + +<img src={useBaseUrl("/img/docker-compose.webp" )} width="150" /> +<br /><br /> :::caution Since `docker-compose` is primarily designed to run a set of containers on **a single host** -and can't credibly support **high availability** as a result, we do not support nor recommend +and can't support requirements for **high availability**, we do not support nor recommend using our `docker-compose` constructs to support production-type use-cases. For single host environments, we recommend using [minikube](https://minikube.sigs.k8s.io/docs/start/) along our [installing on k8s](https://superset.apache.org/docs/installation/running-on-kubernetes) documentation. ::: + +As mentioned in our [quickstart guidee](/docs/quickstart), The fastest way to try Review Comment: ```suggestion As mentioned in our [quickstart guide](/docs/quickstart), The fastest way to try ``` Typo. ########## docs/docs/installation/docker-compose.mdx: ########## @@ -5,23 +5,29 @@ sidebar_position: 3 version: 1 --- -## Using Docker Compose +import useBaseUrl from "@docusaurus/useBaseUrl"; -**DO NOT USE THIS FOR PRODUCTION!** +# Using Docker Compose -The fastest way to try Superset locally is using Docker Compose on a Linux or Mac OSX -computer. Superset does not have official support for Windows. It's also the easiest -way to launch a fully functioning **development environment** quickly. + +<img src={useBaseUrl("/img/docker-compose.webp" )} width="150" /> Review Comment: You don't see webp every day! This won't work with IE11, but that won't keep me up at night. ########## docs/docs/installation/docker-compose.mdx: ########## @@ -5,23 +5,29 @@ sidebar_position: 3 version: 1 --- -## Using Docker Compose +import useBaseUrl from "@docusaurus/useBaseUrl"; -**DO NOT USE THIS FOR PRODUCTION!** +# Using Docker Compose -The fastest way to try Superset locally is using Docker Compose on a Linux or Mac OSX -computer. Superset does not have official support for Windows. It's also the easiest -way to launch a fully functioning **development environment** quickly. + +<img src={useBaseUrl("/img/docker-compose.webp" )} width="150" /> +<br /><br /> :::caution Since `docker-compose` is primarily designed to run a set of containers on **a single host** -and can't credibly support **high availability** as a result, we do not support nor recommend +and can't support requirements for **high availability**, we do not support nor recommend using our `docker-compose` constructs to support production-type use-cases. For single host environments, we recommend using [minikube](https://minikube.sigs.k8s.io/docs/start/) along our [installing on k8s](https://superset.apache.org/docs/installation/running-on-kubernetes) documentation. ::: + +As mentioned in our [quickstart guidee](/docs/quickstart), The fastest way to try +Superset locally is using Docker Compose on a Linux or Mac OSX +computer. Superset does not have official support for Windows. It's also the easiest Review Comment: ```suggestion computer. **Superset does not have official support for Windows**. It's also the easiest ``` I want to use the `<blink>` tag here. ########## docs/src/pages/index.tsx: ########## @@ -28,6 +29,8 @@ import SectionHeader from '../components/SectionHeader'; import BlurredSection from '../components/BlurredSection'; import '../styles/main.less'; +// @ts-ignore Review Comment: ehhhh, how bad is it? Should we fix, or sweep it under the rug? -- 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: notifications-unsubscr...@superset.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For additional commands, e-mail: notifications-h...@superset.apache.org
![https://raw.githubusercontent.com/apache/superset/master/superset-frontend/src/assets/images/screenshots/gallery.jpg"/](https://raw.githubusercontent.com/apache/superset/master/superset-frontend/src/assets/images/screenshots/gallery.jpg"/){kind=link}