chore(docs): migrate documentation to DevHub with GH Pages redirects#382
Draft
pkosiec wants to merge 3 commits into
Draft
chore(docs): migrate documentation to DevHub with GH Pages redirects#382pkosiec wants to merge 3 commits into
pkosiec wants to merge 3 commits into
Conversation
Point all documentation links to https://www.databricks.com/devhub/docs/appkit/v0/. Add a custom Docusaurus postBuild plugin that replaces all generated HTML with redirect pages pointing to DevHub, while preserving llms.txt, .md files, and JSON schemas for npm packaging and IDE validation. Schema $schema/$id URLs remain on GitHub Pages (databricks.github.io/appkit/schemas/). Signed-off-by: Pawel Kosiec <pawel.kosiec@databricks.com>
llms.txt is a static file still served from GH Pages (redirect plugin only replaces HTML). Schemas are also hosted on GH Pages, not devhub. Signed-off-by: Pawel Kosiec <pawel.kosiec@databricks.com>
The Docusaurus postBuild hooks run in parallel, causing the redirect plugin to corrupt llms.txt and .md files by replacing HTML before the llms-txt plugin extracts content. Move redirect logic to a standalone script that runs after docusaurus build completes. Signed-off-by: Pawel Kosiec <pawel.kosiec@databricks.com>
pkosiec
force-pushed
the
pkosiec/deprecate-docs-website
branch
from
7c7a0fe to
41ed381
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates AppKit documentation from GitHub Pages to DevHub.
llms.txt,.mdfiles (needed for npm packaging and IDE validation)Testing
Build and serve docs locally:
pnpm docs:build && pnpm docs:serveVerify these URLs redirect to DevHub:
These should still be served directly (no redirect):