Skip to content

Commit d2907b2

Browse files
rusackasclaude
andauthored
docs: federate scattered markdown files into centralized docs (#36756)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 17d6f4e commit d2907b2

35 files changed

Lines changed: 1233 additions & 804 deletions

File tree

.github/workflows/check_db_migration_confict.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
`❗ @${pull.user.login} Your base branch \`${currentBranch}\` has ` +
7070
'also updated `superset/migrations`.\n' +
7171
'\n' +
72-
'**Please consider rebasing your branch and [resolving potential db migration conflicts](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#merging-db-migrations).**',
72+
'**Please consider rebasing your branch and [resolving potential db migration conflicts](https://superset.apache.org/docs/contributing/development#merging-db-migrations).**',
7373
});
7474
}
7575
}

.pre-commit-config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,3 +149,11 @@ repos:
149149
files: ^superset/db_engine_specs/.*\.py$
150150
exclude: ^superset/db_engine_specs/(base|lib|lint_metadata|__init__)\.py$
151151
pass_filenames: false
152+
- repo: local
153+
hooks:
154+
- id: feature-flags-sync
155+
name: feature flags documentation sync
156+
entry: bash -c 'python scripts/extract_feature_flags.py > docs/static/feature-flags.json.tmp && if ! diff -q docs/static/feature-flags.json docs/static/feature-flags.json.tmp > /dev/null 2>&1; then mv docs/static/feature-flags.json.tmp docs/static/feature-flags.json && echo "Updated docs/static/feature-flags.json" && exit 1; else rm docs/static/feature-flags.json.tmp; fi'
157+
language: system
158+
files: ^superset/config\.py$
159+
pass_filenames: false

INSTALL.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,20 @@ KIND, either express or implied. See the License for the
1616
specific language governing permissions and limitations
1717
under the License.
1818
-->
19-
# INSTALL / BUILD instructions for Apache Superset
19+
# Installing Apache Superset
2020

21-
At this time, the docker file at RELEASING/Dockerfile.from_local_tarball
22-
constitutes the recipe on how to get to a working release from a source
23-
release tarball.
21+
For comprehensive installation instructions, please see the Apache Superset documentation:
22+
23+
**[📚 Installation Guide →](https://superset.apache.org/docs/installation/installation-methods)**
24+
25+
The documentation covers:
26+
- [Docker Compose](https://superset.apache.org/docs/installation/docker-compose) (recommended for development)
27+
- [Kubernetes / Helm](https://superset.apache.org/docs/installation/kubernetes)
28+
- [PyPI](https://superset.apache.org/docs/installation/pypi)
29+
- [Docker Builds](https://superset.apache.org/docs/installation/docker-builds)
30+
- [Architecture Overview](https://superset.apache.org/docs/installation/architecture)
31+
32+
## Building from Source
33+
34+
For building from a source release tarball, see the Dockerfile at:
35+
`RELEASING/Dockerfile.from_local_tarball`

LINTING_ARCHITECTURE.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,14 +168,14 @@ Try out Superset's [quickstart](https://superset.apache.org/docs/quickstart/) gu
168168
## Contributor Guide
169169

170170
Interested in contributing? Check out our
171-
[CONTRIBUTING.md](https://github.com/apache/superset/blob/master/CONTRIBUTING.md)
171+
[Developer Portal](https://superset.apache.org/developer_portal/)
172172
to find resources around contributing along with a detailed guide on
173173
how to set up a development environment.
174174

175175
## Resources
176176

177177
- [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!
178-
- [Feature Flags](https://github.com/apache/superset/blob/master/RESOURCES/FEATURE_FLAGS.md) - the status of Superset's Feature Flags.
178+
- [Feature Flags](https://superset.apache.org/docs/configuration/feature-flags) - the status of Superset's Feature Flags.
179179
- [Standard Roles](https://github.com/apache/superset/blob/master/RESOURCES/STANDARD_ROLES.md) - How RBAC permissions map to roles.
180180
- [Superset Wiki](https://github.com/apache/superset/wiki) - Tons of additional community resources: best practices, community content and other information.
181181
- [Superset SIPs](https://github.com/orgs/apache/projects/170) - The status of Superset's SIPs (Superset Improvement Proposals) for both consensus and implementation status.

RELEASING/release-notes-1-0/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Some of the new features in this release are disabled by default. Each has a fea
9292

9393
| Feature | Feature Flag | Dependencies | Documentation
9494
| --- | --- | --- | --- |
95-
| 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 )
95+
| 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)
9696
| Dashboard Native Filters | `DASHBOARD_NATIVE_FILTERS: True` | |
9797
| Alerts & Reporting | `ALERT_REPORTS: True` | [Celery workers configured & celery beat process](https://superset.apache.org/docs/installation/async-queries-celery) |
9898
| Homescreen Thumbnails | `THUMBNAILS: TRUE, THUMBNAIL_CACHE_CONFIG: CacheConfig = { "CACHE_TYPE": "null", "CACHE_NO_NULL_WARNING": True}`| selenium, pillow 7, celery |

RESOURCES/FEATURE_FLAGS.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

docs/DOCS_CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ If versions don't appear in dropdown:
416416

417417
- [Docusaurus Documentation](https://docusaurus.io/docs)
418418
- [MDX Documentation](https://mdxjs.com/)
419-
- [Superset Contributing Guide](../CONTRIBUTING.md)
419+
- [Superset Developer Portal](https://superset.apache.org/developer_portal/)
420420
- [Main Superset Documentation](https://superset.apache.org/docs/intro)
421421

422422
## 📖 Real Examples and Patterns

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ under the License.
1818
-->
1919

2020
This is the public documentation site for Superset, built using
21-
[Docusaurus 3](https://docusaurus.io/). See
22-
[CONTRIBUTING.md](../CONTRIBUTING.md#documentation) for documentation on
23-
contributing to documentation.
21+
[Docusaurus 3](https://docusaurus.io/). See the
22+
[Developer Portal](https://superset.apache.org/developer_portal/contributing/development-setup#documentation)
23+
for documentation on contributing to documentation.
2424

2525
## Version Management
2626

docs/developer_portal/contributing/development-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -653,7 +653,7 @@ export enum FeatureFlag {
653653
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
654654
in combined feature flags of `{ 'FOO': True, 'BAR': True, 'BAZ': True }`.
655655
656-
The current status of the usability of each flag (stable vs testing, etc) can be found in `RESOURCES/FEATURE_FLAGS.md`.
656+
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.
657657
658658
## Git Hooks
659659

0 commit comments

Comments
 (0)