This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a commit to branch bifurcating_user_admin_docs
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/bifurcating_user_admin_docs by
this push:
new 179e4697290 docs: rename /docs to /user-docs for consistency
179e4697290 is described below
commit 179e469729080016a52ac47b641bb8eb3c84d93f
Author: Evan Rusackas <[email protected]>
AuthorDate: Sun Feb 22 15:21:32 2026 -0800
docs: rename /docs to /user-docs for consistency
Rename the user documentation URL path from /docs to /user-docs to match
the naming convention of /admin-docs and /developer-docs.
Changes:
- Add routeBasePath: 'user-docs' to preset-classic docs config
- Add createRedirects for /docs/* → /user-docs/* pattern-based redirects
- Update all redirect destinations from /docs/* to /user-docs/*
- Update navbar links to use /user-docs/
- Update sitemap priorities to use /user-docs/
- Update internal links in user docs, admin docs, and developer docs
- Update footer security link to /admin-docs/security/
All old /docs/* URLs will automatically redirect to /user-docs/* via
the createRedirects function. Versioned docs at /docs/6.0.0/* remain
unchanged.
Co-Authored-By: Claude Opus 4.5 <[email protected]>
---
docs/admin_docs/configuration/sql-templating.mdx | 2 +-
docs/admin_docs/index.md | 4 +-
docs/admin_docs/installation/docker-compose.mdx | 2 +-
.../contributing/development-setup.md | 2 +-
docs/developer_docs/extensions/tasks.md | 2 +-
docs/docs/faq.mdx | 8 +--
docs/docs/quickstart.mdx | 6 +--
.../creating-your-first-dashboard.mdx | 4 +-
docs/docusaurus.config.ts | 63 ++++++++++++----------
9 files changed, 50 insertions(+), 43 deletions(-)
diff --git a/docs/admin_docs/configuration/sql-templating.mdx
b/docs/admin_docs/configuration/sql-templating.mdx
index 5fdabe27e01..893c1886419 100644
--- a/docs/admin_docs/configuration/sql-templating.mdx
+++ b/docs/admin_docs/configuration/sql-templating.mdx
@@ -8,7 +8,7 @@ version: 1
# SQL Templating
:::tip Looking to use SQL templating?
-For a user-focused guide on writing Jinja templates in SQL Lab and virtual
datasets, see the [SQL Templating User
Guide](/docs/using-superset/sql-templating). This page covers administrator
configuration options.
+For a user-focused guide on writing Jinja templates in SQL Lab and virtual
datasets, see the [SQL Templating User
Guide](/user-docs/using-superset/sql-templating). This page covers
administrator configuration options.
:::
## Jinja Templates
diff --git a/docs/admin_docs/index.md b/docs/admin_docs/index.md
index 2a86b5a4890..aa20a892d5e 100644
--- a/docs/admin_docs/index.md
+++ b/docs/admin_docs/index.md
@@ -15,9 +15,9 @@ This section contains documentation for system administrators
and operators who
## Related
-- **[Database Drivers](/docs/databases)** - See User Docs for database
connection setup (admins may need to install drivers)
+- **[Database Drivers](/user-docs/databases)** - See User Docs for database
connection setup (admins may need to install drivers)
## Looking for something else?
-- **[User Documentation](/docs/intro)** - Guides for analysts and business
users
+- **[User Documentation](/user-docs/intro)** - Guides for analysts and
business users
- **[Developer Documentation](/developer-docs)** - Contributing, extensions,
and development guides
diff --git a/docs/admin_docs/installation/docker-compose.mdx
b/docs/admin_docs/installation/docker-compose.mdx
index 155649902db..04d14915860 100644
--- a/docs/admin_docs/installation/docker-compose.mdx
+++ b/docs/admin_docs/installation/docker-compose.mdx
@@ -21,7 +21,7 @@ with our [installing on
k8s](https://superset.apache.org/admin-docs/installation
documentation.
:::
-As mentioned in our [quickstart guide](/docs/quickstart), the fastest way to
try
+As mentioned in our [quickstart guide](/user-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
way to launch a fully functioning **development environment** quickly.
diff --git a/docs/developer_docs/contributing/development-setup.md
b/docs/developer_docs/contributing/development-setup.md
index a543eb24442..44ff39ada47 100644
--- a/docs/developer_docs/contributing/development-setup.md
+++ b/docs/developer_docs/contributing/development-setup.md
@@ -653,7 +653,7 @@ export enum FeatureFlag {
those specified under FEATURE_FLAGS in `superset_config.py`. For example,
`DEFAULT_FEATURE_FLAGS = { 'FOO': True, 'BAR': False }` in `superset/config.py`
and `FEATURE_FLAGS = { 'BAR': True, 'BAZ': True }` in `superset_config.py` will
result
in combined feature flags of `{ 'FOO': True, 'BAR': True, 'BAZ': True }`.
-The current status of the usability of each flag (stable vs testing, etc) can
be found in the [Feature Flags](/docs/configuration/feature-flags)
documentation.
+The current status of the usability of each flag (stable vs testing, etc) can
be found in the [Feature Flags](/admin-docs/configuration/feature-flags)
documentation.
## Git Hooks
diff --git a/docs/developer_docs/extensions/tasks.md
b/docs/developer_docs/extensions/tasks.md
index c833cd93680..d1f33aa1475 100644
--- a/docs/developer_docs/extensions/tasks.md
+++ b/docs/developer_docs/extensions/tasks.md
@@ -370,7 +370,7 @@ The prune job only removes tasks in terminal states
(`SUCCESS`, `FAILURE`, `ABOR
See `superset/config.py` for a complete example configuration.
:::tip Signal Cache for Faster Notifications
-By default, abort detection and sync join-and-wait use database polling.
Configure `SIGNAL_CACHE_CONFIG` to enable Redis pub/sub for real-time
notifications. See [Signal Cache
Backend](/docs/configuration/cache#signal-cache-backend) for configuration
details.
+By default, abort detection and sync join-and-wait use database polling.
Configure `SIGNAL_CACHE_CONFIG` to enable Redis pub/sub for real-time
notifications. See [Signal Cache
Backend](/admin-docs/configuration/cache#signal-cache-backend) for
configuration details.
:::
## API Reference
diff --git a/docs/docs/faq.mdx b/docs/docs/faq.mdx
index b1ed47088c4..e76b9a488ee 100644
--- a/docs/docs/faq.mdx
+++ b/docs/docs/faq.mdx
@@ -111,7 +111,7 @@ We recommend reading the instructions in
## Can I upload and visualize CSV data?
-Absolutely! Read the instructions [here](/docs/using-superset/exploring-data)
to learn
+Absolutely! Read the instructions
[here](/user-docs/using-superset/exploring-data) to learn
how to enable and use CSV upload.
## Why are my queries timing out?
@@ -213,7 +213,7 @@ table afterwards to configure the Columns tab, check the
appropriate boxes and s
To clarify, the database backend is an OLTP database used by Superset to store
its internal
information like your list of users and dashboard definitions. While Superset
supports a
-[variety of databases as data
_sources_](/docs/databases#installing-database-drivers),
+[variety of databases as data
_sources_](/user-docs/databases#installing-database-drivers),
only a few database engines are supported for use as the OLTP backend /
metadata store.
Superset is tested using MySQL, PostgreSQL, and SQLite backends. It’s
recommended you install
@@ -246,7 +246,7 @@ second etc). Example:
## Does Superset work with [insert database engine here]?
-The [Connecting to Databases section](/docs/databases) provides the best
+The [Connecting to Databases section](/user-docs/databases) provides the best
overview for supported databases. Database engines not listed on that page may
work too. We rely on
the community to contribute to this knowledge base.
@@ -282,7 +282,7 @@ are typical in basic SQL:
## Does Superset offer a public API?
Yes, a public REST API, and the surface of that API formal is expanding
steadily. You can read more about this API and
-interact with it using Swagger [here](/docs/api).
+interact with it using Swagger [here](/user-docs/api).
Some of the
original vision for the collection of endpoints under **/api/v1** was
originally specified in
diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
index cd21ff28e49..a731bb0b16b 100644
--- a/docs/docs/quickstart.mdx
+++ b/docs/docs/quickstart.mdx
@@ -73,8 +73,8 @@ processes by running Docker Compose `stop` command. By doing
so, you can avoid d
From this point on, you can head on to:
-- [Create your first
Dashboard](/docs/using-superset/creating-your-first-dashboard)
-- [Connect to a Database](/docs/databases)
+- [Create your first
Dashboard](/user-docs/using-superset/creating-your-first-dashboard)
+- [Connect to a Database](/user-docs/databases)
- [Using Docker Compose](/admin-docs/installation/docker-compose)
- [Configure Superset](/admin-docs/configuration/configuring-superset)
- [Installing on Kubernetes](/admin-docs/installation/kubernetes)
@@ -84,5 +84,5 @@ Or just explore our
[Documentation](https://superset.apache.org/docs/intro)!
:::resources
- [Video: Superset in 2 Minutes](https://www.youtube.com/watch?v=AqousXQ7YHw)
- [Video: Superset 101](https://www.youtube.com/watch?v=mAIH3hUoxEE)
-- [Tutorial: Creating Your First
Dashboard](/docs/using-superset/creating-your-first-dashboard)
+- [Tutorial: Creating Your First
Dashboard](/user-docs/using-superset/creating-your-first-dashboard)
:::
diff --git a/docs/docs/using-superset/creating-your-first-dashboard.mdx
b/docs/docs/using-superset/creating-your-first-dashboard.mdx
index 7a214037a71..febf3395a6f 100644
--- a/docs/docs/using-superset/creating-your-first-dashboard.mdx
+++ b/docs/docs/using-superset/creating-your-first-dashboard.mdx
@@ -31,7 +31,7 @@ your existing SQL-speaking database or data store.
First things first, we need to add the connection credentials to your database
to be able
to query and visualize data from it. If you're using Superset locally via
-[Docker compose](/docs/installation/docker-compose), you can
+[Docker compose](/admin-docs/installation/docker-compose), you can
skip this step because a Postgres database, named **examples**, is included and
pre-configured in Superset for you.
@@ -193,7 +193,7 @@ Access to dashboards is managed via owners and permissions.
Non-owner access can
through dataset permissions or dashboard-level roles (using the
`DASHBOARD_RBAC` feature flag).
For detailed information on configuring dashboard access, see the
-[Dashboard Access Control](/docs/security/security#dashboard-access-control)
section in the
+[Dashboard Access
Control](/admin-docs/security/security#dashboard-access-control) section in the
Security documentation.
<img src={useBaseUrl("/img/tutorial/tutorial_dashboard_access.png" )} />
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index 447e1c21ef4..0596447c5d2 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -176,7 +176,7 @@ if (!versionsConfig.admin_docs.disabled) {
},
{
label: 'Database Drivers',
- href: '/docs/databases',
+ href: '/user-docs/databases',
},
{
type: 'doc',
@@ -377,15 +377,15 @@ const config: Config = {
from: '/installation.html',
},
{
- to: '/docs/intro',
+ to: '/user-docs/intro',
from: '/tutorials.html',
},
{
- to: '/docs/using-superset/creating-your-first-dashboard',
+ to: '/user-docs/using-superset/creating-your-first-dashboard',
from: '/admintutorial.html',
},
{
- to: '/docs/using-superset/creating-your-first-dashboard',
+ to: '/user-docs/using-superset/creating-your-first-dashboard',
from: '/usertutorial.html',
},
{
@@ -397,11 +397,11 @@ const config: Config = {
from: '/sqllab.html',
},
{
- to: '/docs/intro',
+ to: '/user-docs/intro',
from: '/gallery.html',
},
{
- to: '/docs/databases',
+ to: '/user-docs/databases',
from: '/druid.html',
},
{
@@ -413,23 +413,23 @@ const config: Config = {
from: '/visualization.html',
},
{
- to: '/docs/faq',
+ to: '/user-docs/faq',
from: '/videos.html',
},
{
- to: '/docs/faq',
+ to: '/user-docs/faq',
from: '/faq.html',
},
{
- to: '/docs/using-superset/creating-your-first-dashboard',
+ to: '/user-docs/using-superset/creating-your-first-dashboard',
from: '/tutorial.html',
},
{
- to: '/docs/using-superset/creating-your-first-dashboard',
+ to: '/user-docs/using-superset/creating-your-first-dashboard',
from: '/docs/creating-charts-dashboards/first-dashboard',
},
{
- to: '/docs/api',
+ to: '/user-docs/api',
from: '/docs/rest-api',
},
{
@@ -441,7 +441,7 @@ const config: Config = {
from: '/docs/contributing/hooks-and-linting',
},
{
- to: '/docs/intro',
+ to: '/user-docs/intro',
from: '/docs/roadmap',
},
{
@@ -453,11 +453,11 @@ const config: Config = {
from: '/docs/contributing/contribution-page',
},
{
- to: '/docs/databases',
+ to: '/user-docs/databases',
from: '/docs/databases/yugabyte/',
},
{
- to: '/docs/faq',
+ to: '/user-docs/faq',
from: '/docs/frequently-asked-questions',
},
// Redirects from old /docs/ paths to new /admin-docs/ paths
@@ -559,11 +559,11 @@ const config: Config = {
from: '/docs/contributing/testing-locally/',
},
{
- to: '/docs/using-superset/creating-your-first-dashboard',
+ to: '/user-docs/using-superset/creating-your-first-dashboard',
from:
'/docs/creating-charts-dashboards/creating-your-first-dashboard/',
},
{
- to: '/docs/using-superset/creating-your-first-dashboard',
+ to: '/user-docs/using-superset/creating-your-first-dashboard',
from: '/docs/creating-charts-dashboards/exploring-data/',
},
{
@@ -646,15 +646,21 @@ const config: Config = {
from: '/docs/contributing/pkg-resources-migration',
},
],
- // Use createRedirects for pattern-based redirects from old
developer_portal paths
+ // Use createRedirects for pattern-based redirects
createRedirects(existingPath) {
+ const redirects = [];
+
// Redirect all /developer_portal/* paths to /developer-docs/*
if (existingPath.startsWith('/developer-docs/')) {
- return [
- existingPath.replace('/developer-docs/', '/developer_portal/'),
- ];
+ redirects.push(existingPath.replace('/developer-docs/',
'/developer_portal/'));
+ }
+
+ // Redirect all /docs/* paths to /user-docs/* for user documentation
+ if (existingPath.startsWith('/user-docs/')) {
+ redirects.push(existingPath.replace('/user-docs/', '/docs/'));
}
- return undefined;
+
+ return redirects.length > 0 ? redirects : undefined;
},
},
],
@@ -665,6 +671,7 @@ const config: Config = {
'@docusaurus/preset-classic',
{
docs: {
+ routeBasePath: 'user-docs',
sidebarPath: require.resolve('./sidebars.js'),
editUrl: ({ versionDocsDirPath, docPath }) => {
if (docPath === 'intro.md') {
@@ -707,22 +714,22 @@ const config: Config = {
const items = await defaultCreateSitemapItems(rest);
return items.map((item) => {
// Boost priority for key pages
- if (item.url.includes('/docs/intro')) {
+ if (item.url.includes('/user-docs/intro')) {
return { ...item, priority: 1.0, changefreq: 'daily' };
}
- if (item.url.includes('/docs/quickstart')) {
+ if (item.url.includes('/user-docs/quickstart')) {
return { ...item, priority: 0.9, changefreq: 'weekly' };
}
if (item.url.includes('/admin-docs/installation/')) {
return { ...item, priority: 0.8, changefreq: 'weekly' };
}
- if (item.url.includes('/docs/databases')) {
+ if (item.url.includes('/user-docs/databases')) {
return { ...item, priority: 0.8, changefreq: 'weekly' };
}
if (item.url.includes('/admin-docs/')) {
return { ...item, priority: 0.8, changefreq: 'weekly' };
}
- if (item.url.includes('/docs/faq')) {
+ if (item.url.includes('/user-docs/faq')) {
return { ...item, priority: 0.7, changefreq: 'monthly' };
}
if (item.url === 'https://superset.apache.org/') {
@@ -776,7 +783,7 @@ const config: Config = {
// Users docs - mirrors sidebar structure
{
label: 'Users',
- to: '/docs/intro',
+ to: '/user-docs/intro',
position: 'left',
items: [
{
@@ -849,7 +856,7 @@ const config: Config = {
],
},
{
- href: '/docs/intro',
+ href: '/user-docs/intro',
position: 'right',
className: 'default-button-theme get-started-button',
label: 'Get Started',
@@ -876,7 +883,7 @@ const config: Config = {
<img class="footer__divider" src="/img/community/line.png"
alt="Divider" />
<p>
<small>
- <a href="/docs/security/" target="_blank"
rel="noreferrer">Security</a> |
+ <a href="/admin-docs/security/" target="_blank"
rel="noreferrer">Security</a> |
<a href="https://www.apache.org/foundation/sponsorship.html";
target="_blank" rel="noreferrer">Donate</a> |
<a href="https://www.apache.org/foundation/thanks.html";
target="_blank" rel="noreferrer">Thanks</a> |
<a href="https://apache.org/events/current-event";
target="_blank" rel="noreferrer">Events</a> |
