Skip to content

docs: Update UI5 CLI documentation links to v5 and fix backward-compatible redirects - #1701

Merged
devtomtom merged 9 commits into
mainfrom
docs-v5-links
Nov 10, 2026
Merged

devtomtom merged 9 commits into
mainfrom
docs-v5-links

Conversation

@devtomtom

Copy link
Copy Markdown
Member

Updates all UI5 CLI documentation links to the v5 docs structure and makes v4-style
(trailing-slash) URLs resolve against v5, which serves clean URLs without a trailing slash.

JIRA: CPOUI5FOUNDATION-1373

Changes

  • Retarget documentation links across packages, docs, JSDoc, and schema error messages to
    canonical ui5.github.io/cli/v5/... URLs (no trailing slash).
  • fix(documentation): the Pages 404 handler now tries the slash-stripped URL before falling
    back to the version 404 page, so .../v5/pages/X/ recovers to .../v5/pages/X. Loop guards kept.
  • README: banner now reflects today's state (v5 is in alpha, v4 remains the latest stable);
    resource and per-package API Reference links point at v5.

@devtomtom
devtomtom requested review from flovogt and matz3 November 9, 2026 15:05
Point UI5 Builder documentation links at the v5 docs structure, using
canonical URLs without a trailing slash since v5 docs are served with
clean URLs.

JIRA: CPOUI5FOUNDATION-1373
Update the user-facing init message and CLI documentation links to the
canonical v5 docs URLs. Tests updated in lockstep with the message
string.

JIRA: CPOUI5FOUNDATION-1373
Point the UI5 FS readme documentation and API reference links at the
v5 docs.

JIRA: CPOUI5FOUNDATION-1373
Point the UI5 Logger readme documentation and API reference links at
the v5 docs.

JIRA: CPOUI5FOUNDATION-1373
Update documentation links in JSDoc, error messages, and the validation
schema error messages to the canonical v5 docs URLs. Schema fixtures and
test assertions updated in lockstep.

JIRA: CPOUI5FOUNDATION-1373
Update server middleware migration-guide and documentation links to the
canonical v5 docs URLs. Tests updated in lockstep.

JIRA: CPOUI5FOUNDATION-1373
Update VitePress config, JSDoc config, and docs pages to the canonical
v5 docs URLs, normalizing existing v5 links that carried a trailing
slash.

JIRA: CPOUI5FOUNDATION-1373
v5 documentation is served with clean URLs, so a v4-style link with a
trailing slash returns a 404. When the version exists but the page is
missing, try the slash-stripped URL before falling back to the version
404 page. Loop guards are preserved.

JIRA: CPOUI5FOUNDATION-1373
Reflect the current state: UI5 CLI v5 is in alpha and under active
development, while v4 remains the latest stable version. Point the
resource links at the v5 docs.

JIRA: CPOUI5FOUNDATION-1373

@d3xter666 d3xter666 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

All modified URLs were tested with curl -L. All returned HTTP 200.

@devtomtom
devtomtom merged commit 2ccc5e3 into main Nov 10, 2026
77 checks passed
@devtomtom
devtomtom deleted the docs-v5-links branch November 10, 2026 10:18
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.

2 participants