Skip to content

Commit 0288e59

Browse files
flovogtkonnraad
flovogt
and
konnraad
authored
[FEATURE] Migrate UI5 Tooling documentation to VitePress (#1006)
Migrate to UI5 Vitepress --------- Co-authored-by: Konrad <[email protected]>
1 parent 39398ef commit 0288e59

File tree

128 files changed

+44169
-3003
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+44169
-3003
lines changed

‎.github/workflows/deploy-docs-next.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages (next)
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
push:
9+
branches: [main]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: write
17+
pages: write
18+
id-token: write
19+
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
env:
31+
DOC_VERSION: v4
32+
DOC_ALIAS: stable
33+
GIT_COMMITTER_NAME: "Konrad Kost"
34+
GIT_COMMITTER_EMAIL: "xxxx"
35+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v4
39+
with:
40+
fetch-depth: 0
41+
- name: Setup Node
42+
uses: actions/setup-node@v4
43+
with:
44+
node-version: 20
45+
cache: npm
46+
- name: Setup Pages
47+
uses: actions/configure-pages@v4
48+
- name: Install dependencies
49+
run: npm ci
50+
- name: Fetch gh-pages branch
51+
run: git fetch origin gh-pages --depth=1
52+
- name: Set /site ownership to current user
53+
run: |
54+
mkdir site
55+
sudo chown -R $(id -u):$(id -g) ./site
56+
- name: generate CLI doc
57+
run: npm run generate-cli-doc
58+
- name: generate next config
59+
run: npm run replace-base-path-next
60+
- name: Build jsdoc
61+
run: npm run jsdoc-generate
62+
- name: Build vitepress build
63+
run: npm run docs-generate
64+
- name: Build Schema
65+
run: |
66+
npm run schema-generate
67+
npm run schema-workspace-generate
68+
- name: Checkout gh-pages
69+
uses: actions/checkout@v4
70+
with:
71+
ref: gh-pages
72+
path: gh-pages
73+
- name: Copy the additional resources to gh-pages
74+
run: |
75+
rm -rf ./gh-pages/schema
76+
cp -R ./site/schema ./gh-pages/
77+
rm -rf ./gh-pages/next/
78+
cp -R ./site ./gh-pages/next/
79+
cp ./scripts/resources/custom404.html ./gh-pages/404.html
80+
- name: Publish Docs
81+
run: |
82+
cd ./gh-pages
83+
git config --local user.email $GIT_COMMITTER_EMAIL
84+
git config --local user.name $GIT_COMMITTER_NAME
85+
git add .
86+
git commit -m "Updating supplemental resources for ${DOC_VERSION} documentation deployment"
87+
git push

‎.github/workflows/deploy-docs-stable.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages (stable)
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
push:
9+
branches: [main]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: write
17+
pages: write
18+
id-token: write
19+
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
env:
31+
DOC_VERSION: v4
32+
DOC_ALIAS: stable
33+
GIT_COMMITTER_NAME: "Konrad Kost"
34+
GIT_COMMITTER_EMAIL: "xxxx"
35+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v4
39+
with:
40+
fetch-depth: 0
41+
- name: Setup Node
42+
uses: actions/setup-node@v4
43+
with:
44+
node-version: 20
45+
cache: npm
46+
- name: Setup Pages
47+
uses: actions/configure-pages@v4
48+
- name: Install dependencies
49+
run: npm ci
50+
- name: Fetch gh-pages branch
51+
run: git fetch origin gh-pages --depth=1
52+
- name: Set /site ownership to current user
53+
run: |
54+
mkdir site
55+
sudo chown -R $(id -u):$(id -g) ./site
56+
- name: generate CLI doc
57+
run: npm run generate-cli-doc
58+
- name: generate stable Config
59+
run: npm run replace-base-path-stable
60+
- name: Build jsdoc
61+
run: npm run jsdoc-generate
62+
- name: Build vitepress build
63+
run: npm run docs-generate
64+
- name: Build Schema
65+
run: |
66+
npm run schema-generate
67+
npm run schema-workspace-generate
68+
- name: Checkout gh-pages
69+
uses: actions/checkout@v4
70+
with:
71+
ref: gh-pages
72+
path: gh-pages
73+
- name: Copy the additional resources to gh-pages
74+
run: |
75+
rm -rf ./gh-pages/schema
76+
cp -R ./site/schema ./gh-pages/
77+
rm -rf ./gh-pages/stable/
78+
cp -R ./site ./gh-pages/stable/
79+
cp ./scripts/resources/custom404.html ./gh-pages/404.html
80+
- name: Publish Docs
81+
run: |
82+
cd ./gh-pages
83+
git config --local user.email $GIT_COMMITTER_EMAIL
84+
git config --local user.name $GIT_COMMITTER_NAME
85+
git add .
86+
git commit -m "Updating supplemental resources for ${DOC_VERSION} documentation deployment"
87+
git push

‎.github/workflows/deploy-docs.yml‎

Lines changed: 79 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,85 @@
1-
name: Build and Deploy Docs
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages
4+
25
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
38
push:
4-
branches:
5-
- main
6-
jobs:
7-
build-and-deploy:
8-
name: Build and Deploy
9-
runs-on: ubuntu-latest
10-
env:
11-
MIKE_VERSION: v4
12-
MIKE_ALIAS: stable
13-
DOCKER_IMAGE: ui5-tooling/mkdocs-material
14-
GIT_COMMITTER_NAME: "OpenUI5 Bot"
15-
GIT_COMMITTER_EMAIL: "[email protected]"
16-
17-
steps:
18-
- name: Checkout
19-
uses: actions/checkout@v4
20-
21-
- name: Use Node.js LTS 20.x
22-
uses: actions/[email protected]
23-
with:
24-
node-version: 20.x
9+
branches: [main]
2510

26-
- name: Install npm dependencies
27-
run: npm ci
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
2813

29-
- name: Fetch gh-pages branch
30-
run: git fetch origin gh-pages --depth=1
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: write
17+
pages: write
18+
id-token: write
3119

32-
- name: Set /site ownership to current user
33-
run: |
34-
mkdir site
35-
sudo chown -R $(id -u):$(id -g) ./site
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
3625

37-
- name: Build docs with Mike
38-
run: ./scripts/buildDocs.sh
39-
40-
- name: Publish docs
41-
run: docker run --rm -v $(pwd):/docs --entrypoint mike --env GIT_COMMITTER_NAME="${GIT_COMMITTER_NAME}" --env GIT_COMMITTER_EMAIL="${GIT_COMMITTER_EMAIL}" $DOCKER_IMAGE set-default stable --push
42-
43-
- name: Build Schema
44-
run: |
45-
npm run schema-generate
46-
npm run schema-workspace-generate
47-
48-
- name: Checkout gh-pages
49-
uses: actions/checkout@v4
50-
with:
51-
ref: gh-pages
52-
path: gh-pages
53-
- name: Copy the additional resources to gh-pages
54-
run: |
55-
rm -rf ./gh-pages/schema
56-
cp -R ./site/schema ./gh-pages/
57-
rm -rf ./gh-pages/$MIKE_VERSION/api
58-
cp -R ./site/api ./gh-pages/$MIKE_VERSION/
59-
cp ./scripts/resources/custom404.html ./gh-pages/404.html
60-
- name: Publish Docs
61-
run: |
62-
cd ./gh-pages
63-
git config --local user.email $GIT_COMMITTER_EMAIL
64-
git config --local user.name $GIT_COMMITTER_NAME
65-
git add .
66-
git commit -m "Updating supplemental resources for ${MIKE_VERSION} documentation deployment"
67-
git push
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
env:
31+
DOC_VERSION: v4
32+
DOC_ALIAS: stable
33+
GIT_COMMITTER_NAME: "Konrad Kost"
34+
GIT_COMMITTER_EMAIL: "xxxx"
35+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v4
39+
with:
40+
fetch-depth: 0
41+
- name: Setup Node
42+
uses: actions/setup-node@v4
43+
with:
44+
node-version: 20
45+
cache: npm
46+
- name: Setup Pages
47+
uses: actions/configure-pages@v4
48+
- name: Install dependencies
49+
run: npm ci
50+
- name: Fetch gh-pages branch
51+
run: git fetch origin gh-pages --depth=1
52+
- name: Set /site ownership to current user
53+
run: |
54+
mkdir site
55+
sudo chown -R $(id -u):$(id -g) ./site
56+
- name: generate CLI doc
57+
run: npm run generate-cli-doc
58+
- name: Build jsdoc
59+
run: npm run jsdoc-generate
60+
- name: Build vitepress build
61+
run: npm run docs-generate
62+
- name: Build Schema
63+
run: |
64+
npm run schema-generate
65+
npm run schema-workspace-generate
66+
- name: Checkout gh-pages
67+
uses: actions/checkout@v4
68+
with:
69+
ref: gh-pages
70+
path: gh-pages
71+
- name: Copy the additional resources to gh-pages
72+
run: |
73+
rm -rf ./gh-pages/schema
74+
cp -R ./site/schema ./gh-pages/
75+
rm -rf ./gh-pages/$DOC_VERSION
76+
cp -R ./site ./gh-pages/$DOC_VERSION/
77+
cp ./scripts/resources/custom404.html ./gh-pages/404.html
78+
- name: Publish Docs
79+
run: |
80+
cd ./gh-pages
81+
git config --local user.email $GIT_COMMITTER_EMAIL
82+
git config --local user.name $GIT_COMMITTER_NAME
83+
git add .
84+
git commit -m "Updating supplemental resources for ${DOC_VERSION} documentation deployment"
85+
git push

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,5 @@ site/
6161

6262
# Custom files
6363
docs/pages/CLI.md
64+
docs/CLI.md
65+

‎.vitepress/cache/deps/_metadata.json‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"hash": "b5613d59",
3+
"configHash": "20d54342",
4+
"lockfileHash": "23ddd169",
5+
"browserHash": "87e1e698",
6+
"optimized": {
7+
"vue": {
8+
"src": "../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
9+
"file": "vue.js",
10+
"fileHash": "457aabc7",
11+
"needsInterop": false
12+
},
13+
"vitepress > @vue/devtools-api": {
14+
"src": "../../../node_modules/@vue/devtools-api/dist/index.js",
15+
"file": "vitepress___@vue_devtools-api.js",
16+
"fileHash": "a0e6c966",
17+
"needsInterop": false
18+
},
19+
"vitepress > @vueuse/core": {
20+
"src": "../../../node_modules/@vueuse/core/index.mjs",
21+
"file": "vitepress___@vueuse_core.js",
22+
"fileHash": "61414c6a",
23+
"needsInterop": false
24+
},
25+
"vitepress > @vueuse/integrations/useFocusTrap": {
26+
"src": "../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
27+
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
28+
"fileHash": "df15f6d5",
29+
"needsInterop": false
30+
},
31+
"vitepress > mark.js/src/vanilla.js": {
32+
"src": "../../../node_modules/mark.js/src/vanilla.js",
33+
"file": "vitepress___mark__js_src_vanilla__js.js",
34+
"fileHash": "89b842e5",
35+
"needsInterop": false
36+
},
37+
"vitepress > minisearch": {
38+
"src": "../../../node_modules/minisearch/dist/es/index.js",
39+
"file": "vitepress___minisearch.js",
40+
"fileHash": "3f20f67f",
41+
"needsInterop": false
42+
}
43+
},
44+
"chunks": {
45+
"chunk-YVCV7MZG": {
46+
"file": "chunk-YVCV7MZG.js"
47+
},
48+
"chunk-45KCXATN": {
49+
"file": "chunk-45KCXATN.js"
50+
}
51+
}
52+
}

0 commit comments

Comments
 (0)