Skip to content

fix: include language mount paths in documentation URLs - #19

Open
Hanabi9248 wants to merge 1 commit into
IvorySQL:mainfrom
Hanabi9248:codex/doc-site-url-locales-nov08
Open

Hanabi9248 wants to merge 1 commit into
IvorySQL:mainfrom
Hanabi9248:codex/doc-site-url-locales-nov08

Conversation

@Hanabi9248

Copy link
Copy Markdown

The build scripts publish English and Chinese documentation under separate /en and /cn directories, but both playbooks set site.url to the domain root. Antora consequently generates canonical and sitemap URLs without the language mount, and corresponding English and Chinese pages identify the same canonical URL.

Set each playbook's site URL to its language mount. This also supplies the intended site pathname for navigation and redirects; output directories and relative page paths remain unchanged.

Validation with actual Antora 3.1.7, a local two-language Git content fixture and the current official UI ZIPs: baseline has five failing URL checks and two output/link controls passing; candidate passes all seven, without skips. Generated canonical URLs and sitemap entries include their language, and no nested en/en or cn/cn output is introduced. Runs used one CPU, 768 MiB aggregate memory, sixteen processes and private TMP.

An additional candidate integration run enabled the real Lunr extension with the configured EN and CN languages, generated both search indexes using the current UI ZIPs, loaded them with the real Lunr engine and queried the fixture Welcome page. Both result links resolve under the appropriate /en or /cn mount. This checks generated indexes and link resolution; it does not exercise browser interaction or Chinese-language query quality.

The fixture uses local content/bundles and a fixture start page, disables network refresh and omits PDF. Full remote content generation, PDF, browser behavior and live deployment were not run. The live language-page fetches were unavailable and are not evidence of a production HTTP error.

Set each Antora site URL to its published /en or /cn mount so canonical
and sitemap URLs identify the corresponding language site.

Validation: real Antora 3.1.7 HTML/URL fixture with current UI ZIPs;
baseline 5 failures and 2 controls pass, candidate 7 checks pass.
PDF/search extensions, full remote content and browser deployment unrun.

Signed-off-by: Hanabi9248 <hanabi210902@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant