diff --git a/docs/developer_docs/extensions/development.md b/docs/developer_docs/extensions/development.md index a6c143a3796..a927e44962e 100644 --- a/docs/developer_docs/extensions/development.md +++ b/docs/developer_docs/extensions/development.md @@ -248,7 +248,7 @@ superset-extensions dev ## Contributing Extension-Compatible Components -Components in `@apache-superset/core` are automatically documented in the Developer Portal. Simply add a component to the package and it will appear in the extension documentation. +Components in `@apache-superset/core` are automatically documented in the Developer Docs. Simply add a component to the package and it will appear in the extension documentation. ### Requirements @@ -307,7 +307,7 @@ When the docs site is built (`yarn start` or `yarn build` in the `docs/` directo - Props table from story `args` - Usage code snippet - Links to source files -3. Pages appear automatically in **Developer Portal → Extensions → Components** +3. Pages appear automatically in **Developer Docs → Extensions → Components** ### Best Practices diff --git a/docs/developer_docs/index.md b/docs/developer_docs/index.md index fb2de2c70a1..2bfc2bba9ca 100644 --- a/docs/developer_docs/index.md +++ b/docs/developer_docs/index.md @@ -22,9 +22,9 @@ specific language governing permissions and limitations under the License. --> -# Apache Superset Developer Portal +# Developer Docs -Welcome to the Apache Superset Developer Portal - your comprehensive resource for contributing to and extending Apache Superset. +Welcome to the Apache Superset Developer Docs - your comprehensive resource for contributing to and extending Apache Superset. ## Quick Start diff --git a/docs/docs/index.md b/docs/docs/index.md index 4921692e769..7c480fd476d 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -105,83 +105,83 @@ Superset provides: ## Supported Databases -Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](https://superset.apache.org/docs/databases)) that has a Python DB-API driver and a SQLAlchemy dialect. +Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](/user-docs/databases/)) that has a Python DB-API driver and a SQLAlchemy dialect. Here are some of the major database solutions that are supported:

- Amazon Athena   - Amazon DynamoDB   - Amazon Redshift   - Apache Doris   - Apache Drill   - Apache Druid   - Apache Hive   - Apache Impala   - Apache Kylin   - Apache Pinot   - Apache Solr   - Apache Spark SQL   - Ascend   - Aurora MySQL (Data API)   - Aurora PostgreSQL (Data API)   - Azure Data Explorer   - Azure Synapse   - ClickHouse   - Cloudflare D1   - CockroachDB   - Couchbase   - CrateDB   - Databend   - Databricks   - Denodo   - Dremio   - DuckDB   - Elasticsearch   - Exasol   - Firebird   - Firebolt   - Google BigQuery   - Google Sheets   - Greenplum   - Hologres   - IBM Db2   - IBM Netezza Performance Server   - MariaDB   - Microsoft SQL Server   - MonetDB   - MongoDB   - MotherDuck   - OceanBase   - Oracle   - Presto   - RisingWave   - SAP HANA   - SAP Sybase   - Shillelagh   - SingleStore   - Snowflake   - SQLite   - StarRocks   - Superset meta database   - TDengine   - Teradata   - TimescaleDB   - Trino   - Vertica   - YDB   - YugabyteDB + Amazon Athena   + Amazon DynamoDB   + Amazon Redshift   + Apache Doris   + Apache Drill   + Apache Druid   + Apache Hive   + Apache Impala   + Apache Kylin   + Apache Pinot   + Apache Solr   + Apache Spark SQL   + Ascend   + Aurora MySQL (Data API)   + Aurora PostgreSQL (Data API)   + Azure Data Explorer   + Azure Synapse   + ClickHouse   + Cloudflare D1   + CockroachDB   + Couchbase   + CrateDB   + Databend   + Databricks   + Denodo   + Dremio   + DuckDB   + Elasticsearch   + Exasol   + Firebird   + Firebolt   + Google BigQuery   + Google Sheets   + Greenplum   + Hologres   + IBM Db2   + IBM Netezza Performance Server   + MariaDB   + Microsoft SQL Server   + MonetDB   + MongoDB   + MotherDuck   + OceanBase   + Oracle   + Presto   + RisingWave   + SAP HANA   + SAP Sybase   + Shillelagh   + SingleStore   + Snowflake   + SQLite   + StarRocks   + Superset meta database   + TDengine   + Teradata   + TimescaleDB   + Trino   + Vertica   + YDB   + YugabyteDB

-**A more comprehensive list of supported databases** along with the configuration instructions can be found [here](https://superset.apache.org/docs/databases). +**A more comprehensive list of supported databases** along with the configuration instructions can be found [here](/user-docs/databases/). -Want to add support for your datastore or data engine? Read more [here](https://superset.apache.org/docs/frequently-asked-questions#does-superset-work-with-insert-database-engine-here) about the technical requirements. +Want to add support for your datastore or data engine? Read more [here](/user-docs/faq#does-superset-work-with-insert-database-engine-here) about the technical requirements. ## Installation and Configuration -Try out Superset's [quickstart](https://superset.apache.org/docs/quickstart/) guide or learn about [the options for production deployments](https://superset.apache.org/docs/installation/architecture/). +Try out Superset's [quickstart](/user-docs/quickstart) guide or learn about [the options for production deployments](/admin-docs/installation/installation-methods). ## Get Involved @@ -195,14 +195,14 @@ Try out Superset's [quickstart](https://superset.apache.org/docs/quickstart/) gu ## Contributor Guide Interested in contributing? Check out our -[Developer Portal](https://superset.apache.org/developer-docs/) +[Developer Docs](https://superset.apache.org/developer-docs/) to find resources around contributing along with a detailed guide on how to set up a development environment. ## Resources - [Superset "In the Wild"](https://superset.apache.org/inTheWild) - see who's using Superset, and [add your organization](https://github.com/apache/superset/edit/master/RESOURCES/INTHEWILD.yaml) to the list! -- [Feature Flags](https://superset.apache.org/docs/configuration/feature-flags) - the status of Superset's Feature Flags. +- [Feature Flags](/admin-docs/configuration/feature-flags) - the status of Superset's Feature Flags. - [Standard Roles](https://github.com/apache/superset/blob/master/RESOURCES/STANDARD_ROLES.md) - How RBAC permissions map to roles. - [Superset Wiki](https://github.com/apache/superset/wiki) - Tons of additional community resources: best practices, community content and other information. - [Superset SIPs](https://github.com/orgs/apache/projects/170) - The status of Superset's SIPs (Superset Improvement Proposals) for both consensus and implementation status. @@ -213,10 +213,10 @@ Understanding the Superset Points of View - [Understanding the Superset Semantic Layer](https://preset.io/blog/understanding-superset-semantic-layer/) - Getting Started with Superset - - [Superset in 2 Minutes using Docker Compose](https://superset.apache.org/docs/installation/docker-compose#installing-superset-locally-using-docker-compose) - - [Installing Database Drivers](https://superset.apache.org/docs/configuration/databases#installing-database-drivers) + - [Superset in 2 Minutes using Docker Compose](/admin-docs/installation/docker-compose#installing-superset-locally-using-docker-compose) + - [Installing Database Drivers](/admin-docs/configuration/configuring-superset#installing-database-drivers) - [Building New Database Connectors](https://preset.io/blog/building-database-connector/) - - [Create Your First Dashboard](https://superset.apache.org/docs/using-superset/creating-your-first-dashboard/) + - [Create Your First Dashboard](/user-docs/using-superset/creating-your-first-dashboard) - [Comprehensive Tutorial for Contributing Code to Apache Superset ](https://preset.io/blog/tutorial-contributing-code-to-apache-superset/) - [Resources to master Superset by Preset](https://preset.io/resources/) @@ -240,7 +240,7 @@ Understanding the Superset Points of View - [Managing and Deploying Custom Viz Plugins](https://medium.com/nmc-techblog/apache-superset-manage-custom-viz-plugins-in-production-9fde1a708e55) - [Why Apache Superset is Betting on Apache ECharts](https://preset.io/blog/2021-4-1-why-echarts/) -- [Superset API](https://superset.apache.org/docs/rest-api) +- [Superset API](/developer-docs/api) ## Repo Activity