This is an automated email from the ASF dual-hosted git repository. rusackas pushed a commit to branch docs/federate-contributing-links in repository https://gitbox.apache.org/repos/asf/superset.git
commit 8dd74086888af41814e4a322b8ff10fccbe08772 Author: Evan Rusackas <[email protected]> AuthorDate: Thu Dec 18 15:24:04 2025 -0800 docs: update CONTRIBUTING.md links to point to docs site Updates all references to CONTRIBUTING.md anchors throughout the codebase to point directly to the appropriate docs pages: - Async Chart Queries links → docs/contributing/misc#async-chart-queries - DB migrations links → docs/contributing/development#merging-db-migrations - Contributing Guide links → developer_portal/ CONTRIBUTING.md remains as a redirect stub for GitHub's built-in features and any external links. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]> --- .github/workflows/check_db_migration_confict.yml | 2 +- README.md | 2 +- RELEASING/release-notes-1-0/README.md | 2 +- RESOURCES/FEATURE_FLAGS.md | 2 +- docs/DOCS_CLAUDE.md | 2 +- docs/README.md | 6 +++--- docs/developer_portal/index.md | 1 - docs/versioned_docs/version-6.0.0/intro.md | 2 +- helm/superset/README.md | 2 +- helm/superset/values.yaml | 2 +- superset-core/README.md | 2 +- superset-extensions-cli/README.md | 2 +- superset-frontend/packages/superset-core/README.md | 2 +- superset-websocket/README.md | 2 +- 14 files changed, 15 insertions(+), 16 deletions(-) diff --git a/.github/workflows/check_db_migration_confict.yml b/.github/workflows/check_db_migration_confict.yml index b0da6094f0..e5db0dd555 100644 --- a/.github/workflows/check_db_migration_confict.yml +++ b/.github/workflows/check_db_migration_confict.yml @@ -69,7 +69,7 @@ jobs: `❗ @${pull.user.login} Your base branch \`${currentBranch}\` has ` + 'also updated `superset/migrations`.\n' + '\n' + - '**Please consider rebasing your branch and [resolving potential db migration conflicts](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#merging-db-migrations).**', + '**Please consider rebasing your branch and [resolving potential db migration conflicts](https://superset.apache.org/docs/contributing/development#merging-db-migrations).**', }); } } diff --git a/README.md b/README.md index f7d59ee691..455b764eae 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,7 @@ Try out Superset's [quickstart](https://superset.apache.org/docs/quickstart/) gu ## Contributor Guide Interested in contributing? Check out our -[CONTRIBUTING.md](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) +[Developer Portal](https://superset.apache.org/developer_portal/) to find resources around contributing along with a detailed guide on how to set up a development environment. diff --git a/RELEASING/release-notes-1-0/README.md b/RELEASING/release-notes-1-0/README.md index 6379bf099c..8bb50cc5c0 100644 --- a/RELEASING/release-notes-1-0/README.md +++ b/RELEASING/release-notes-1-0/README.md @@ -92,7 +92,7 @@ Some of the new features in this release are disabled by default. Each has a fea | Feature | Feature Flag | Dependencies | Documentation | --- | --- | --- | --- | -| Global Async Queries | `GLOBAL_ASYNC_QUERIES: True` | Redis 5.0+, celery workers configured and running | [Extra documentation](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries ) +| Global Async Queries | `GLOBAL_ASYNC_QUERIES: True` | Redis 5.0+, celery workers configured and running | [Extra documentation](https://superset.apache.org/docs/contributing/misc#async-chart-queries) | Dashboard Native Filters | `DASHBOARD_NATIVE_FILTERS: True` | | | Alerts & Reporting | `ALERT_REPORTS: True` | [Celery workers configured & celery beat process](https://superset.apache.org/docs/installation/async-queries-celery) | | Homescreen Thumbnails | `THUMBNAILS: TRUE, THUMBNAIL_CACHE_CONFIG: CacheConfig = { "CACHE_TYPE": "null", "CACHE_NO_NULL_WARNING": True}`| selenium, pillow 7, celery | diff --git a/RESOURCES/FEATURE_FLAGS.md b/RESOURCES/FEATURE_FLAGS.md index d4b47d0b6b..32e291b083 100644 --- a/RESOURCES/FEATURE_FLAGS.md +++ b/RESOURCES/FEATURE_FLAGS.md @@ -49,7 +49,7 @@ These features are **finished** but currently being tested. They are usable, but - DATE_FORMAT_IN_EMAIL_SUBJECT: [(docs)](https://superset.apache.org/docs/configuration/alerts-reports#commons) - ENABLE_SUPERSET_META_DB: [(docs)](https://superset.apache.org/docs/configuration/databases/#querying-across-databases) - ESTIMATE_QUERY_COST -- GLOBAL_ASYNC_QUERIES [(docs)](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries) +- GLOBAL_ASYNC_QUERIES [(docs)](https://superset.apache.org/docs/contributing/misc#async-chart-queries) - IMPERSONATE_WITH_EMAIL_PREFIX - PLAYWRIGHT_REPORTS_AND_THUMBNAILS - RLS_IN_SQLLAB diff --git a/docs/DOCS_CLAUDE.md b/docs/DOCS_CLAUDE.md index 42fd0ad71a..039b701ba1 100644 --- a/docs/DOCS_CLAUDE.md +++ b/docs/DOCS_CLAUDE.md @@ -416,7 +416,7 @@ If versions don't appear in dropdown: - [Docusaurus Documentation](https://docusaurus.io/docs) - [MDX Documentation](https://mdxjs.com/) -- [Superset Contributing Guide](../CONTRIBUTING.md) +- [Superset Developer Portal](https://superset.apache.org/developer_portal/) - [Main Superset Documentation](https://superset.apache.org/docs/intro) ## 📖 Real Examples and Patterns diff --git a/docs/README.md b/docs/README.md index 8af3ea90da..dbf7a51238 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,9 +18,9 @@ under the License. --> This is the public documentation site for Superset, built using -[Docusaurus 3](https://docusaurus.io/). See -[CONTRIBUTING.md](../CONTRIBUTING.md#documentation) for documentation on -contributing to documentation. +[Docusaurus 3](https://docusaurus.io/). See the +[Developer Portal](https://superset.apache.org/developer_portal/contributing/development-setup#documentation) +for documentation on contributing to documentation. ## Version Management diff --git a/docs/developer_portal/index.md b/docs/developer_portal/index.md index fce0b76456..fe567fcc5a 100644 --- a/docs/developer_portal/index.md +++ b/docs/developer_portal/index.md @@ -86,7 +86,6 @@ Everything you need to contribute to the Apache Superset project. This section i - **[Configuration Guide](https://superset.apache.org/docs/configuration/configuring-superset)** - Setup and configuration ### Important Files -- **[CONTRIBUTING.md](https://github.com/apache/superset/blob/master/CONTRIBUTING.md)** - Contribution guidelines - **[CLAUDE.md](https://github.com/apache/superset/blob/master/CLAUDE.md)** - LLM development guide - **[UPDATING.md](https://github.com/apache/superset/blob/master/UPDATING.md)** - Breaking changes log diff --git a/docs/versioned_docs/version-6.0.0/intro.md b/docs/versioned_docs/version-6.0.0/intro.md index d1dc1527bb..67e3e205f2 100644 --- a/docs/versioned_docs/version-6.0.0/intro.md +++ b/docs/versioned_docs/version-6.0.0/intro.md @@ -165,7 +165,7 @@ Try out Superset's [quickstart](https://superset.apache.org/docs/quickstart/) gu ## Contributor Guide Interested in contributing? Check out our -[CONTRIBUTING.md](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) +[Developer Portal](https://superset.apache.org/developer_portal/) to find resources around contributing along with a detailed guide on how to set up a development environment. diff --git a/helm/superset/README.md b/helm/superset/README.md index 5371e88b11..ebf1708b8c 100644 --- a/helm/superset/README.md +++ b/helm/superset/README.md @@ -257,7 +257,7 @@ On helm this can be set on `extraSecretEnv.SUPERSET_SECRET_KEY` or `configOverri | supersetWebsockets.config | object | see `values.yaml` | The config.json to pass to the server, see https://github.com/apache/superset/tree/master/superset-websocket Note that the configuration can also read from environment variables (which will have priority), see https://github.com/apache/superset/blob/master/superset-websocket/src/config.ts for a list of supported variables | | supersetWebsockets.containerSecurityContext | object | `{}` | | | supersetWebsockets.deploymentAnnotations | object | `{}` | | -| supersetWebsockets.enabled | bool | `false` | This is only required if you intend to use `GLOBAL_ASYNC_QUERIES` in `ws` mode see https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries | +| supersetWebsockets.enabled | bool | `false` | This is only required if you intend to use `GLOBAL_ASYNC_QUERIES` in `ws` mode see https://superset.apache.org/docs/contributing/misc#async-chart-queries | | supersetWebsockets.extraContainers | list | `[]` | Launch additional containers into supersetWebsockets pods | | supersetWebsockets.image.pullPolicy | string | `"IfNotPresent"` | | | supersetWebsockets.image.repository | string | `"oneacrefund/superset-websocket"` | There is no official image (yet), this one is community-supported | diff --git a/helm/superset/values.yaml b/helm/superset/values.yaml index 65d4bda943..a3853e798c 100644 --- a/helm/superset/values.yaml +++ b/helm/superset/values.yaml @@ -612,7 +612,7 @@ supersetCeleryFlower: supersetWebsockets: # -- This is only required if you intend to use `GLOBAL_ASYNC_QUERIES` in `ws` mode - # see https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries + # see https://superset.apache.org/docs/contributing/misc#async-chart-queries enabled: false replicaCount: 1 # -- Sets the [pod disruption budget](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) for supersetWebsockets pods diff --git a/superset-core/README.md b/superset-core/README.md index fa8e879112..3ee489c7af 100644 --- a/superset-core/README.md +++ b/superset-core/README.md @@ -94,7 +94,7 @@ rest_api.add_extension_api(DatasetReferencesAPI) ## 🤝 Contributing -We welcome contributions! Please see the [Contributing Guide](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) for details. +We welcome contributions! Please see the [Developer Portal](https://superset.apache.org/developer_portal/) for details. ## 📄 License diff --git a/superset-extensions-cli/README.md b/superset-extensions-cli/README.md index 642bce25f3..00b75f9ef3 100644 --- a/superset-extensions-cli/README.md +++ b/superset-extensions-cli/README.md @@ -91,7 +91,7 @@ extension_name/ ## 🤝 Contributing -We welcome contributions! Please see the [Contributing Guide](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) for details. +We welcome contributions! Please see the [Developer Portal](https://superset.apache.org/developer_portal/) for details. ## 📄 License diff --git a/superset-frontend/packages/superset-core/README.md b/superset-frontend/packages/superset-core/README.md index 2705bf33d9..948f8ac39d 100644 --- a/superset-frontend/packages/superset-core/README.md +++ b/superset-frontend/packages/superset-core/README.md @@ -97,7 +97,7 @@ export function deactivate() { ## 🤝 Contributing -We welcome contributions! Please see the [Contributing Guide](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) for details. +We welcome contributions! Please see the [Developer Portal](https://superset.apache.org/developer_portal/) for details. ## 📄 License diff --git a/superset-websocket/README.md b/superset-websocket/README.md index 79cbe81397..10dbcfd20f 100644 --- a/superset-websocket/README.md +++ b/superset-websocket/README.md @@ -97,7 +97,7 @@ GLOBAL_ASYNC_QUERIES_JWT_COOKIE_NAME GLOBAL_ASYNC_QUERIES_JWT_SECRET ``` -More info on Superset configuration values for async queries: https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries +More info on Superset configuration values for async queries: https://superset.apache.org/docs/contributing/misc#async-chart-queries ## StatsD monitoring
