feat: migrate documentation site to OINK 1.0 - #466
Open
imbajin wants to merge 16 commits into
Open
Conversation
- pin OINK, Go, Hugo, and GitHub Actions versions - replace Docsy landing and bilingual configuration - add strict production and staging artifact validation - preserve aliases, machine outputs, and license notices
- convert 45 bilingual details blocks with OINK tooling - verify tables, nested code, and long JSON examples - remove obsolete Node and S3 Docsy entry points - retain zero residual legacy constructs
- resolve latest, 1.7, and 1.5 to exact commit SHAs - build isolated production and staging artifacts - validate URL, language, metadata, and license contracts - aggregate reviewed outputs before staging or production publish
- move the site logo from the Apache /icons alias - update OINK branding to use /img/logo.svg - enforce the hosted asset path in the URL contract
- resolve PR builds from the exact source head - keep shell, scripts, content, and metadata aligned - verify the pinned OINK checksum, identity, and replacement
- restore the original homepage copy and brand artwork - localize CSP-sensitive images and add responsive assets - fix bilingual search, version, 404, and accessibility behavior - harden historical builds and output security validation
- restore the real three-link historical overlay contract - normalize archived Server headings outside fenced code - keep 404 pages out of canonical and hreflang clusters - close srcset and aggregate security validation gaps
- scope missing translations to the current artifact base - validate language actions against hreflang contracts - cover URL, metadata, active-state, and escape regressions
- add localized accessible names to rendered page TOCs - validate labels in the actual artifact publication path - preserve the security-only validator contract
- group bilingual docs by user tasks across versions - fix scoped anchors and image descriptions - improve mobile tables and deny staged Git metadata - harden navigation and historical adapter validation
- remove generated OINK and browser dependency notices - stop copying and validating the static license bundle - retain the OINK attribution in the repository NOTICE
- add the refined homepage checkpoint for A-to-B-to-C comparison - add a concise OINK capability overview for the PR - keep migration visuals reviewable with the source branch
- restore the original homepage and bilingual Community content - integrate the homepage header and simplify the ASF footer - move staging and CI to the standard ASF preview domain - preserve historical builds with optional shared-footer rewrites
- point both language pages to the current Community anchor - keep the restored Community entry paths consistent - resolve the final independent review finding
- preserve the existing standard ASF staging site - restore the OINK-specific preview profile and hostname - validate the dedicated profile in aggregate tests
- capture the final desktop and mobile OINK homepage - record the restored Community landing page - preserve the existing standard staging design as a reference
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.
Test drive
Try the main migration improvements directly:
/or⌘KThe preview uses the same version manifest, build matrix, validation, and publication path intended for
master.Why this migration
This PR moves the Apache HugeGraph documentation site from Docsy to pinned OINK 1.0.
It keeps the familiar HugeGraph product story and public URLs while improving how users find, navigate, search, and compare documentation across languages and supported versions.
Visual evolution: A → B → C
The append-only design history, including alternative and mobile checkpoints, remains available in #467.
What improves
latest,1.7, and1.5documentation;/docs/...,/cn/docs/..., blog, download, and/client-go/routes;master.Main changes
Mobile preview
Verification
latest,1.7, and1.5;/client-go/endpoint remain compatible.Current CI details remain available from the pull request checks.
Rollback and exclusions
The migration can be reverted through the repository's normal pull-request revert flow; it does not require rewriting published branch history.
This PR intentionally does not redesign the future contributor gallery, mechanically rewrite unrelated historical content, define a new EOL-wide SEO policy, or add an API renderer without a reliable OpenAPI source. Those improvements should be handled independently.