Commit Graph

22 Commits

Author SHA1 Message Date
Claude Code
b4a0439756 chore(docs): refresh auto-gen before cut, delete empty versions.json on remove
Two related fixes to make the version cut self-contained and to clean
up after itself.

1. addVersion now runs `generate:smart` before snapshotting, so the
   versioned copy captures fresh database pages (from engine spec
   metadata), API reference (from openapi.json), and component pages
   (from Storybook stories) rather than whatever happened to be on
   disk. Added a --skip-generate flag for canonical release cuts where
   the operator has placed the `database-diagnostics` artifact from a
   green Python-Integration CI run at docs/src/data/databases.json and
   wants to preserve the full Flask-context diagnostics rather than
   regenerate locally.

2. removeVersion previously left an empty `<section>_versions.json`
   file (`[]`) on disk when removing the last version. Docusaurus
   would then snapshot that empty file back into content directories
   on the next cut. (This is how the orphan files this PR already
   cleans up — docs/components/versions.json and
   docs/developer_docs/versions.json — got accidentally tracked.) The
   remove path now deletes the file when it becomes empty.

Documented the cut prerequisites in docs/README.md ("Before You Cut")
and docs/DOCS_CLAUDE.md.
2026-05-13 17:15:29 -07:00
Claude Code
152370b52b chore(docs): clean up version-cutting tooling and finish developer_portal rename
Tooling-only prep for the upcoming docs version cut. Snapshots will land
in a follow-up PR.

- Finish the developer_portal -> developer_docs rename: update package.json
  scripts, manage-versions.mjs usage strings, DocVersionBadge plugin id list
  (replaces bogus 'tutorials' and 'developer_portal' ids with the real
  'default', 'components', 'admin_docs', 'developer_docs'), DocVersionBanner
  dead branch, DOCS_CLAUDE.md, README.md
- Add admin_docs version add/remove scripts (which previously didn't exist)
- Generalize fixVersionedImports in manage-versions.mjs to walk every
  section's snapshot dir with a depth-aware regex, and skip fenced code
  blocks; replaces the previous hard-coded two-file list
- Remove orphan files: developer_portal_versions.json, tutorials_versions.json
  (no such plugin), and the empty docs/components/versions.json and
  docs/developer_docs/versions.json that were accidentally tracked inside
  content directories
- Exclude auto-generated sidebar.js and sidebar.ts from the ASF license check
  (these are produced by docs/scripts/convert-api-sidebar.mjs from the
  OpenAPI spec, and a future version cut would otherwise commit them)
2026-05-13 17:15:29 -07:00
Evan Rusackas
6589ee48f9 docs: bifurcate documentation into user and admin sections (#38196)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-26 13:29:08 -08:00
Evan Rusackas
d2907b2577 docs: federate scattered markdown files into centralized docs (#36756)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-21 13:00:54 -08:00
Evan Rusackas
0a45a89786 feat(docs): Docusaurus multi-versioning, Developer Portal starter kit (#34271)
Co-authored-by: Claude <noreply@anthropic.com>
2025-08-22 09:53:01 -07:00
Đỗ Trọng Hải
2d8892958e docs: various enhancements across /docs workspace (#31921)
Signed-off-by: hainenber <dotronghai96@gmail.com>
2025-02-20 09:18:49 -05:00
Maxime Beauchemin
bc8e9513bf docs: fix broken links in CI (#30496) 2024-10-02 09:15:58 -06:00
Maxime Beauchemin
6b0d8ed265 feat: docker image tags documentation + tweaks (#26923)
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
2024-02-01 18:04:23 -08:00
Evan Rusackas
5392a8c50f chore(actions): run docs actions on Node 16 to conform with the project (#26868)
Co-authored-by: Maxime Beauchemin <maximebeauchemin@gmail.com>
2024-01-29 16:53:38 -07:00
Srini Kadamati
ce1974176f docs: fix alt image issue (#20856) 2022-07-26 08:25:27 -04:00
Cody Leff
fadf0ec5ad Update documentation on updating documentation. (#20400) 2022-06-16 15:05:37 -06:00
Ville Brofeldt
3313530f4d docs: update lock + general cleanup (#19350)
* docs: update lock file

* remove redundant npm lock file

* add missing peer deps

* fix TODO and bump antd

* fix API spec script
2022-03-24 15:43:30 +02:00
Hugh A. Miles II
9c3205b573 feat: 🚀 Docs V2 CI Script (#18560)
* switch to v2

* promote docv2

* remove on triggers
2022-02-02 13:02:51 -08:00
ʈᵃᵢ
e913ef3261 docs: add publish step (#14304) 2021-04-23 10:43:58 -06:00
Amit Miran
b221417e19 chore: remove harmless incubator refs (#12289)
* chore: migrate all harmless incubator refs like comments and documentation files

* chore: migrate all superset.incubator.apache.org to superset.apache.org to

* chore: migrate dist.apache.org refs

* chore: removing incubating and Disclaimer

* fix: linting issues
2021-01-06 13:45:19 +02:00
Srini Kadamati
3e22668f8d docs: restored page on roles in security, executed other touchups, and… (#11978)
* Restored docs page on roles in security, executed other touchups, and renamed docs readme.txt to readme.md

* missed a url anchor on the security page

* fixed licensing issue and limited char width to 80

* fixed licensing issue and limited char width to 80

* whitespace experiments

* removed 2 periods

* staging whitespace

* addressed Robs feedback

* implemented robs second round of feedback on public_role_like
2020-12-13 14:06:14 -08:00
Maxime Beauchemin
6358a7f1b5 docs: add API page to docs using Swagger UI (#11154)
* docs: add API page to docs using Swagger UI

* silence fossa
2020-10-04 22:01:36 -07:00
Srini Kadamati
4a4fdb1e02 docs: set up client-side redirects from previous era docs urls (#10921)
* one simple redirect, as a test

* adding license to header

* painstakingly added SEO redirects!

* addressed feedback and ran lint-fix!

* lets try newline again!

* Revert "lets try newline again!"

This reverts commit 20f89bd23c.

* Revert "Revert "lets try newline again!""

This reverts commit e441edc54a.

* wait... there were TWO newlines?

Co-authored-by: Evan Rusackas <evan@preset.io>
2020-09-18 13:31:22 -07:00
Maxime Beauchemin
3b035d2af3 docs: redirect http -> https (#10900)
* docs: redirect http -> https

* fix issues
2020-09-16 08:24:08 -07:00
Evan Rusackas
1f7301025a correcting 2 steps in docs deployment readme (#10899) 2020-09-15 22:09:32 -07:00
Maxime Beauchemin
08ec509dc9 docs(style): make more responsive for mobile (#10853)
* docs(style): make more responsive for mobile

* Make a responsive navbar

* more fixes and tweaks

* Add README instructions
2020-09-14 11:58:45 -07:00
Phillip Kelley-Dotson
85a916036c docs(new docs site): removes old sphinx doc site with gatsby (#10784)
* Remove old apache sphinx doc site with refreshed gatsby

* remove rando

* add licenses

* excluing .mdx files from license checks

* fixes

* Clean up sphinx references

* Addressed comments

* colors and tweaks

* more fixes

* add dummy docs/requirements.txt to satisfy stupid fossa

* cp .prettierrc

* more licenses

* minor touchups

* reqs

* removing old videos

* add github buttons

* prettier

* tweaks

* Eugenia/Fix some of the images and modified some of database pages

* add subheadernav

* add side headers nav and more responsive design for docs

* update resources page and other styling updates

* linting

* tweaks

* removing windows and align:center

* update resources

* remove links and and card hearder

* lots of styling tweaks

* Tweaks and minor improvements

* lint

* fix CI

* trigger pre-comimt

* rererefix CI

Co-authored-by: Maxime Beauchemin <maximebeauchemin@gmail.com>
Co-authored-by: Eugenia Moreno <eugenia@Eugenias-MBP.fios-router.home>
Co-authored-by: Evan Rusackas <evan@preset.io>
2020-09-11 22:59:12 -07:00