-
Notifications
You must be signed in to change notification settings - Fork 75
feat: Enable vitepress build #1133
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
037ceae to
31934ec
Compare
8961b0d to
7a2ce4f
Compare
64066ac to
f3a5128
Compare
6afdfe1 to
36c75f1
Compare
0107968 to
af5446d
Compare
7d5eba8 to
8beda5d
Compare
c1e36b7 to
a934f2a
Compare
|
|
a934f2a to
c1e36b7
Compare
The CLI page must be generated via the |
d0c7ac3 to
5311640
Compare
My intention was to do the cleanup in the next step, but now I have fixed the formatting and links. |
This PR aims to cleanup redundant files & configurations from the legacy MkDocs build JIRA: CPOUI5FOUNDATION-899
de2cb77 to
e0aa321
Compare
Co-authored-by: Max Reichmann <[email protected]>
Co-authored-by: Max Reichmann <[email protected]>
|
I really don't wanna be picky, but the last change regarding removing the quotes would need to be applied for every |
|
|
||
| export default defineConfig({ | ||
|
|
||
| base: "/ui5-cli/stable/", // use this for github pages deployment or remove for CF |
There was a problem hiding this comment.
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))' |
There was a problem hiding this comment.
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>; |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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"/> |
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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" } |
There was a problem hiding this comment.
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", |
There was a problem hiding this comment.
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/
| 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", | ||
| }); |
There was a problem hiding this comment.
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" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ::: 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" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ::: info "No changes for Specification Versions 2.x and 3.x" | |
| ::: info No changes for Specification Versions 2.x and 3.x |

This change continues the efforts from #1132 and enhances it by enabling vitepress build of the documentation.
JIRA: CPOUI5FOUNDATION-899