Skip to content

feat(docs): serve werf 3 documentation as the latest version - #853

Merged
alexey-igrychev merged 4 commits into
mainfrom
chore/release/v3-latest
Sep 24, 2026
Merged

alexey-igrychev merged 4 commits into
mainfrom
chore/release/v3-latest

Conversation

@alexey-igrychev

Copy link
Copy Markdown
Member

Summary

Make werf v3 the current documentation version on the website while preserving explicit access to v2 and v1.2.

What

  • Route /docs/ and /docs/latest/ to v3 documentation and point the English and Russian Documentation menus at /docs/v3/.
  • Scope documentation search to v3 on v3/latest/preview pages, retaining the v2 and v1.2 scopes on their versioned pages.
  • Keep /docs/v2/ and /docs/v1.2/ available through the existing version routing.
  • Allow crawlers to index v3 and list its sitemap, while preserving v2 indexing and its sitemap.
  • Match production routing in the local documentation proxy and backend configuration.

Why

werf v3 is moving to the main development branch. The website must use the same default documentation version instead of continuing to direct readers and search engines to v2.

Point the current docs root at v3, so /docs/ and the latest alias resolve
to v3 while v2 and v1.2 stay addressable under their own prefixes.

Update the Documentation menu link, doc group detection for search and the
local dev proxy accordingly.

Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>
Render the production chart for both clusters and assert the backend
CURRENT_DOCS_MAJOR env, the /docs/ redirect and the latest alias shortcuts,
plus doc group detection, the dev proxy and the Documentation menu link.

Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>
Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>
@alexey-igrychev

Copy link
Copy Markdown
Member Author

Verification

  • task site:check-docs-roots passes: production Helm renders for both clusters, current/supported backend roots, root/latest rewrites, local proxy/backend settings, navigation, robots and sitemaps.
  • The JavaScript check executes the real version-group function for latest, v3, v2, v1.2, previews and non-docs URLs.
  • Mutation checks reject restoring v2 as current, dropping v2 support, disabling latest, reverting JavaScript defaults or local backend configuration, and removing the v3 navigation/crawler/sitemap entries.
  • Independent review traced latest through the backend to its X-Accel-Redirect and approved the final diff.

Follow-up

  • Merge only after v3 werf#7377 is merged and the v3 production docs deployment is healthy.
  • Verify live English/Russian root/latest/v2 routes after deployment.

@alexey-igrychev
alexey-igrychev marked this pull request as ready for review September 24, 2026 20:56
Both are proper names used in the v3 documentation and were rejected by the spell check.

Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>
@alexey-igrychev

Copy link
Copy Markdown
Member Author

Added Podman and netavark to the spell-check dictionary (scripts/docs/spelling/wordlist and the generated scripts/docs/spelling/dictionaries/dev_OPS.dic). Both are proper names used in the v3 documentation; the spell check rejected them, which also fails on main and on the pre-existing baseline run, so this is not introduced by the routing change.

Note: task site:generate-special-dictionary regenerates the dictionary strictly from the wordlist, and the committed dictionary contained one extra entry (CRDs) that is not in the wordlist. That entry is preserved here so the change stays limited to the two new words.

@alexey-igrychev
alexey-igrychev merged commit e03255d into main Sep 24, 2026
6 checks passed
@alexey-igrychev
alexey-igrychev deleted the chore/release/v3-latest branch September 24, 2026 21:50
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