Repository navigation
[docs] Migrate documentation from Hugo to Docusaurus - #4593
Merged
Merged
Conversation
yuxiqian
force-pushed
the
docusaurus-migration
branch
from
October 23, 2026 08:32
fb8fe5b to
bce7781
Compare
Move Chinese pages to the Docusaurus locale directory and rename Hugo section indexes without changing file contents. Generated-by: Codex 0.163.0
Replace Hugo templates and shortcodes with a bilingual static site. Preserve page URLs and add local search, version interpolation, and a sidebar layout with a light code theme. Generated-by: Codex 0.163.0
Build master and its release alias with Node.js, then append Maven Javadoc. Historical branches keep their original Hugo build scripts. Generated-by: Codex 0.163.0
Generated-by: Codex 0.163.0
yuxiqian
force-pushed
the
docusaurus-migration
branch
from
October 23, 2026 09:47
bce7781 to
b1cdf3d
Compare
leonardBang
reviewed
Oct 24, 2026
Commit the npm lockfile and use npm ci for local and CI documentation builds. Generated-by: Codex 0.164.0
Use Docusaurus navbar navigation while retaining localized links to historical documentation. Generated-by: Codex 0.164.0
leonardBang
approved these changes
Oct 26, 2026
leonardBang
left a comment
leonardBang
left a comment
Contributor
There was a problem hiding this comment.
Thanks @yuxiqian for the update, +1
Member
Author
|
Thank you for reviewing this, will merge it after CI passes to avoid conflicts. |
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
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.
What is the purpose of this pull request?
Like apache/paimon#7922, migrate the master documentation from Hugo to Docusaurus with the following improvements:
This only affects master (and the next 3.8 release). Previously released docs will not change at all.
I've deployed it on my forked GitHub pages. Feel free to review and leave any comments on this change.
Highlights
Modern but familiar look
I keep the original Apache Flink docs style (Hugo book), but clearer and more modern.
Also, it would be easier to write documentations in Docusaurus in the future.
Faster, more convenient documentation search:
previous version, requires 5 seconds to load, no detailed context or "all results" page
new version, instant search result, clear and highlighted results
Documentation
Was generative AI tooling used to co-author this PR?
Generated-by: Codex 0.163.0