Repository navigation
[Website] Publish versioned Paimon C++ documentation - #38
Merged
Merged
Conversation
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.
The website currently publishes only main-branch C++ documentation at
docs/cpp/. Publish the stable release at that URL, development documentation atdocs/cpp/main/, and archived series atdocs/cpp/X.Y/, using the version list maintained on paimon-cpp main.Full labels such as
0.4.0 (stable)selectrelease-0.4; archived0.3.0selectsrelease-0.3. Promoting the upstream version list for 0.4 requires no website version configuration changes. Each build setsPAIMON_DOCS_VERSIONfor the switcher and warning banner, installs the branch's requirements, and receives the shared version list from main.Stage all versions before replacing the published tree, preserving Sphinx assets and nested version directories. Missing branches, invalid metadata, or failed builds stop publication. README is unchanged.
Related: apache/paimon-cpp@2c6f749
Dependency: apache/paimon-cpp#496 provides version navigation on release-0.3 and must land before publishing that branch with navigation.
Validation:
bash -n .github/workflows/cpp-docs.shandgit diff --checkpassed, including after rebasing onto current master.