Skip to content

Conversation

@d3xter666
Copy link
Member

This change continues the efforts from #1132 and enhances it by enabling vitepress build of the documentation.

JIRA: CPOUI5FOUNDATION-899

@d3xter666 d3xter666 force-pushed the feat-create-docsumentation-package branch from 037ceae to 31934ec Compare October 10, 2025 11:37
@d3xter666 d3xter666 force-pushed the feat-enable-vitepress branch from 8961b0d to 7a2ce4f Compare October 10, 2025 11:39
@d3xter666 d3xter666 requested a review from a team October 10, 2025 11:41
@d3xter666 d3xter666 force-pushed the feat-create-docsumentation-package branch from 64066ac to f3a5128 Compare October 14, 2025 06:51
@d3xter666 d3xter666 force-pushed the feat-enable-vitepress branch 2 times, most recently from 6afdfe1 to 36c75f1 Compare October 14, 2025 11:02
@d3xter666 d3xter666 force-pushed the feat-create-docsumentation-package branch from 0107968 to af5446d Compare October 14, 2025 12:27
Base automatically changed from feat-create-docsumentation-package to main October 14, 2025 12:34
@d3xter666 d3xter666 force-pushed the feat-enable-vitepress branch from 7d5eba8 to 8beda5d Compare October 14, 2025 12:38
@d3xter666 d3xter666 requested a review from RandomByte October 14, 2025 13:08
@d3xter666 d3xter666 requested a review from a team October 16, 2025 06:56
@d3xter666 d3xter666 force-pushed the feat-enable-vitepress branch from c1e36b7 to a934f2a Compare October 20, 2025 09:48
@maxreichmann
Copy link
Member

/pages/CLI.html returns a 404.
It is referenced multiple times such as in the sidebar or in /pages/GettingStarted.html as "Next page"

@d3xter666 d3xter666 force-pushed the feat-enable-vitepress branch from a934f2a to c1e36b7 Compare October 21, 2025 06:25
@d3xter666
Copy link
Member Author

/pages/CLI.html returns a 404. It is referenced multiple times such as in the sidebar or in /pages/GettingStarted.html as "Next page"

The CLI page must be generated via the npm run generate-cli-doc script in the root of the monorepo

@d3xter666 d3xter666 force-pushed the feat-enable-vitepress branch from d0c7ac3 to 5311640 Compare October 21, 2025 08:37
@maxreichmann
Copy link
Member

maxreichmann commented Oct 21, 2025

Remark 1:
Wouldn't it make sense to move all the migration guide files from packages/documentation/docs/updates to the general pages directory packages/documentation/docs/pages?
We would then have all files in a combined directory and this would fix some 404 linkings e.g. of the button "Migrate to v4" on Home.html.

Remark 2:
These migration guide files contain wrongly formatted info/warning/success elements which have to be replaced.
e.g.:
image

  • For !!! tip, we can use ::: tip [...] ::: and remove the indendation
  • the same works for !!! warning
  • for !!! success, we have to find a different alternative

Since those files haven't been touched in this PR yet, I couldn't create a GH code suggestion.

@d3xter666
Copy link
Member Author

We would then have all files in a combined directory and this would fix some 404 linkings e.g. of the button "Migrate to v4" on Home.html.

My intention was to do the cleanup in the next step, but now I have fixed the formatting and links.
Thanks!

@d3xter666 d3xter666 force-pushed the feat-enable-vitepress branch from de2cb77 to e0aa321 Compare October 22, 2025 07:28
@maxreichmann
Copy link
Member

I really don't wanna be picky, but the last change regarding removing the quotes would need to be applied for every ::: occurrence where it is necessary 😅

@d3xter666 d3xter666 requested review from a team and maxreichmann October 22, 2025 10:33

export default defineConfig({

base: "/ui5-cli/stable/", // use this for github pages deployment or remove for CF
Copy link
Member

Choose a reason for hiding this comment

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

Is this the right url? ui5-cli?
Currently it does not appear anywhere. Our docs URLs look like this: https://ui5.github.io/cli/

export default {
async load() {
// fetch remote data
const service = 'https://services.odata.org/Trippin_Staging/(S(iw1anra4xygjyssbeef0yeyy))'
Copy link
Member

Choose a reason for hiding this comment

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

Where do we need this?

private _qResetDataSource?;
people(): PersonCollectionService<ClientType>;
people(id: PersonId): PersonService<ClientType>;
airlines(): AirlineCollectionService<ClientType>;
Copy link
Member

Choose a reason for hiding this comment

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

I do not think that this whole folder is needed for our documentation.

1. Switch to the branch that contains your change
```sh
(cd ../ui5-builder && git checkout my-change)
(cd ../pages/builder && git checkout my-change)
Copy link
Member

Choose a reason for hiding this comment

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

This looks like an unexpected change (also few lines below).


[**API Reference**](https://ui5.github.io/cli/v4/api/index.html){: .md-button .sap-icon-initiative }
<div style="margin: 1rem 0;">
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/index.html"/>
Copy link
Member

Choose a reason for hiding this comment

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

Why is there a link specifically for v4? Isn't this the v5 / next version here?


description: "An open and modular toolchain to develop state-of-the-art applications based on the UI5 framework.",
lastUpdated: false, // disable git author info
cleanUrls: false,
Copy link
Member

Choose a reason for hiding this comment

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

Is this the setting that would remove the additional .html from the URLs? In our current documentation we don't have a .html extension for the pages, but in the version here I get URLs like http://localhost:8080/ui5-cli/v5/pages/Configuration.html, which might break links and/or SEO.

description: "An open and modular toolchain to develop state-of-the-art applications based on the UI5 framework.",
lastUpdated: false, // disable git author info
cleanUrls: false,
ignoreDeadLinks: true,
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason for this setting?

head: [
[
"link",
{ rel: "icon", type: "image/svg+xml", href: "/icons/ui5/O.svg" }
Copy link
Member

Choose a reason for hiding this comment

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

where is this file?



logo: {
light: "/images/Logo_B_RGB.png",
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure whether an absolute URL will work, as the site is hosted at https://ui5.github.io/cli/

Comment on lines +100 to +116
md.use(MarkdownItPlantuml, {
//imageFormat: 'png'
});
// https://github.com/gmunguia/markdown-it-plantuml/issues/35
md.use(MarkdownItPlantuml, {
openMarker: "```plantuml",
closeMarker: "```",
diagramName: "uml",
imageFormat: "svg",
});
// Textik https://textik.com/
md.use(MarkdownItPlantuml, {
openMarker: "```ditaa",
closeMarker: "```",
diagramName: "ditaa",
imageFormat: "png",
});
Copy link
Member

Choose a reason for hiding this comment

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

do we need this?


!!! warning "Superseded"
**UI5 CLI 3.0 has been superseded by version 4.0. See [Migrate to v4](./migrate-v4.md).**
::: warning "Superseded"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
::: warning "Superseded"
::: warning Superseded


!!! success "No changes for Specification Versions 2.x and 3.x"
Projects defining **Specification Version 2.x or 3.x** are expected to be **fully compatible with UI5 CLI v4**
::: info "No changes for Specification Versions 2.x and 3.x"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
::: info "No changes for Specification Versions 2.x and 3.x"
::: info No changes for Specification Versions 2.x and 3.x

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.

4 participants