rusackas opened a new pull request, #40081:
URL: https://github.com/apache/superset/pull/40081
### SUMMARY
Cuts a `6.1.0` snapshot for all four versioned Docusaurus sections (`docs`,
`admin_docs`, `developer_docs`, `components`).
**Targets `chore/docs-cut-6.1.0-versions` (#39837), not master.** That PR
contains the version-cutting tooling changes that make this snapshot
well-formed (data-import freeze, depth-aware import rewriter, auto-gen refresh,
empty-versions-file cleanup, etc.). Merge order: tooling first, then this.
**Versioning behavior**: `lastVersion` stays at `current` for every section,
so the canonical URLs (`/docs/...`, `/admin-docs/...`, `/developer-docs/...`,
`/components/...`) continue to render content from master. The `current`
version is consistently labeled "Next" with an `unreleased` banner, and `6.1.0`
is a historical pin accessible only via its explicit version segment.
**Component playground**: previously `disabled: true` in
`versions-config.json`, now enabled and versioned. The plugin block in
`docusaurus.config.ts` was already gated only by the `disabled` flag, so no
other code changes were needed to bring it back online.
**What's in the snapshot**:
- All MDX content for the four sections at the SHA we cut from.
- Auto-generated content captured fresh: 74 database pages (from
`superset/db_engine_specs/` metadata), ~1,800 API reference files (from
`static/resources/openapi.json` via `gen-api-docs`), 59 component pages (from
Storybook stories).
- Data imports frozen at cut time into snapshot-local `_versioned_data/`
dirs:
- `versioned_docs/version-6.1.0/_versioned_data/src/data/databases.json` —
the canonical 80-database diagnostics from CI (preserved by the generator's
input-hash cache, not a local-Flask-env fallback).
-
`admin_docs_versioned_docs/version-6.1.0/_versioned_data/data/countries.json` —
supported-countries list for the Country Map Tools page.
-
`admin_docs_versioned_docs/version-6.1.0/_versioned_data/static/feature-flags.json`
— feature flag tables.
-
`developer_docs_versioned_docs/version-6.1.0/_versioned_data/static/data/components.json`
— component playground index metadata.
- Import paths in deeply-nested files rewritten (`../../../src/...` etc.) so
they still resolve correctly from one directory deeper inside the snapshot.
**Canonical-cut caveat**: this cut was produced locally via `node
scripts/manage-versions.mjs add <section> 6.1.0` for each section. The frozen
`databases.json` is the canonical 80-database version from master (input-hash
cache kept the database generator from running). API reference and component
pages are deterministic from committed inputs, so they match what CI would
produce.
If you want a re-cut from a known-good CI artifact (the
`database-diagnostics` artifact from a green `Python-Integration` run), the
tooling supports it: place the artifact at `docs/src/data/databases.json` and
run with `--skip-generate`. See `docs/README.md` "Before You Cut".
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N/A (versioning change; surfaces existing content under new URL paths).
### TESTING INSTRUCTIONS
```bash
cd docs
yarn install
yarn build
yarn serve
```
Verify:
1. The version dropdown badge appears on all four sections (`/docs/...`,
`/admin-docs/...`, `/developer-docs/...`, `/components/...`) and includes both
`Next` and `6.1.0`.
2. The canonical URL for each section (without a version segment) renders
the `current` content with the "unreleased" banner, matching the latest source.
3. Adding `/6.1.0` to any section URL renders the historical snapshot with
no banner.
4. `country-map-tools.mdx` (admin_docs/6.1.0) renders all 201 countries from
a frozen JSON.
5. `feature-flags.mdx` (admin_docs/6.1.0) renders the feature-flag tables
from a frozen JSON.
6. `databases/index.mdx` (docs/6.1.0) renders the 80-database list from a
frozen `databases.json`.
### ADDITIONAL INFORMATION
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in
[SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
