Skip to content

Commit e8ccfeb

Browse files
authored
Merge pull request #642 from kaggis/update-docs
ARGO-5106 Migrate mkdocs to latest docusaurus
2 parents f5b97f0 + 8fc8667 commit e8ccfeb

File tree

129 files changed

+18766
-97
lines changed

Some content is hidden

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

129 files changed

+18766
-97
lines changed

.github/workflows/docs.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# .github/workflows/docs.yml
2+
name: Deploy documentation to github pages
3+
4+
# Define when to run action
5+
on:
6+
# run action on push to devel branch
7+
push:
8+
branches: [ devel ]
9+
10+
# run also this workflow manually when needed
11+
workflow_dispatch:
12+
13+
# github token permissions are set here
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
# deployment concurrency set to one
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: true
23+
24+
defaults:
25+
run:
26+
working-directory: website
27+
28+
jobs:
29+
build-and-deploy:
30+
runs-on: ubuntu-latest
31+
32+
steps:
33+
- name: Checkout docusaurus repository
34+
uses: actions/checkout@v4
35+
36+
- name: Setup Node environment
37+
uses: actions/setup-node@v4
38+
with:
39+
node-version: '22'
40+
cache: 'npm'
41+
cache-dependency-path: docs/package-lock.json
42+
43+
- name: Install deps
44+
run: npm i
45+
46+
- name: Build docs
47+
run: npm run build
48+
49+
- name: Run gh action to setup pages
50+
uses: actions/configure-pages@v5
51+
52+
- name: Upload docs
53+
uses: actions/upload-pages-artifact@v3
54+
with:
55+
path: 'docs/build'
56+
57+
- name: Run gh action to deploy to github pages
58+
id: deployment
59+
uses: actions/deploy-pages@v4

doc/v1/docs/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

doc/v1/docs/superadmin_administration.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

doc/v1/mkdocs.yml

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

docs/README.md

Lines changed: 41 additions & 0 deletions

docs/docs/intro.md

Lines changed: 37 additions & 0 deletions
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"label": "SuperAdmin Poem",
3+
"position": 1,
4+
"collapsed": false,
5+
"link": { "type": "generated-index", "description": "Start here" }
6+
}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"label": "Administration",
3+
"position": 1,
4+
"collapsed": false,
5+
"link": { "type": "generated-index", "description": "Start here" }
6+
}

doc/v1/docs/figures/superadmin_administration.png renamed to docs/docs/super-admin-poem/administration/figures/superadmin_administration.png

File renamed without changes.

0 commit comments

Comments
 (0)