feat: configure docs deployment to github pages

OHDSI · Oct 20, 2024 · 62c5641 · 62c5641
1 parent dab7ac5
commit 62c5641
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 16 deletions.
diff --git a/doc/.github/workflows/deploy-docs.yml → .github/workflows/deploy-docs.yml b/doc/.github/workflows/deploy-docs.yml → .github/workflows/deploy-docs.yml
@@ -1,11 +1,11 @@
-
 name: Deploy Docs
 
 on:
   push:
     branches:
-      # make sure this is the branch you are using
       - main
+    paths:
+      - 'docs/**'
 
 permissions:
   contents: write
@@ -18,10 +18,6 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-          # if your docs needs submodules, uncomment the following line
-          # submodules: true
-
-
 
       - name: Setup Node.js
         uses: actions/setup-node@v3
@@ -30,18 +26,27 @@ jobs:
           cache: npm
 
       - name: Install Deps
+        working-directory: ./docs
         run: npm ci
 
+      - name: Clean dist folder
+        run: rm -rf docs/.vuepress/dist
+
       - name: Build Docs
+        working-directory: ./docs
         env:
           NODE_OPTIONS: --max_old_space_size=8192
-        run: |-
-          npm run docs:build
-          > docs/.vuepress/dist/.nojekyll
+        run: |
+          npm run docs:build || echo "Build failed"
+
+      - name: Verify dist folder exists
+        run: ls -la docs/.vuepress/dist
+
+      - name: Create .nojekyll file
+        run: echo "" > docs/.vuepress/dist/.nojekyll
 
       - name: Deploy Docs
         uses: JamesIves/github-pages-deploy-action@v4
         with:
-          # This is the branch where the docs are deployed to
           branch: gh-pages
           folder: docs/.vuepress/dist
diff --git a/doc/docs/.vuepress/config.js → docs/docs/.vuepress/config.js b/doc/docs/.vuepress/config.js → docs/docs/.vuepress/config.js
@@ -4,17 +4,17 @@ import { viteBundler } from '@vuepress/bundler-vite'
 
 export default defineUserConfig({
   lang: 'en-US',
-
+  base: '/Ares/',
   title: 'Ares',
   description: 'A Research Exploration System',
 
   theme: defaultTheme({
-    logo: '../icon.png',
-
+    logo: './icon.png',
     navbar: ['/', '/ares-docs'],
     colorMode: 'dark',
     colorModeSwitch: false,
 
   }),
   bundler: viteBundler(),
+  dest: '.vuepress/dist'
 })
diff --git a/doc/docs/ares_logo.svg → docs/docs/.vuepress/public/ares_logo.svg b/doc/docs/ares_logo.svg → docs/docs/.vuepress/public/ares_logo.svg
diff --git a/doc/docs/icon.png → docs/docs/.vuepress/public/icon.png b/doc/docs/icon.png → docs/docs/.vuepress/public/icon.png
diff --git a/doc/docs/README.md → docs/docs/README.md b/doc/docs/README.md → docs/docs/README.md
@@ -1,7 +1,7 @@
 ---
 home: true
 title: Home
-heroImage: /icon.png
+heroImage: ./icon.png
 actions:
   - text: Get Started
     link: /ares-docs.html#installation

diff --git a/doc/docs/ares-docs.md → docs/docs/ares-docs.md b/doc/docs/ares-docs.md → docs/docs/ares-docs.md
@@ -101,11 +101,13 @@ cdmSourceName = 'synthea'
 cdmVersion = "5.4" #do not change
 
 aresDataDirectory = "./data" #output directory
-sourceReleaseKey = AresIndexer::getSourceReleaseKey(connectionDetails, cdmDatabaseSchema)
 sourceFolders = "./data" #source files folder for indexers.
 
 connectionDetails <- Eunomia::getEunomiaConnectionDetails() #Provides a sample dataset
 
+sourceReleaseKey = AresIndexer::getSourceReleaseKey(connectionDetails, cdmDatabaseSchema)
+
+
 # Example connection details 
 #connectionDetails <- DatabaseConnector::createConnectionDetails(
 #  dbms     = dbms, #your database management system

diff --git a/doc/docs/sample-iqr.png → docs/docs/sample-iqr.png b/doc/docs/sample-iqr.png → docs/docs/sample-iqr.png
diff --git a/doc/package-lock.json → docs/package-lock.json b/doc/package-lock.json → docs/package-lock.json
diff --git a/doc/package.json → docs/package.json b/doc/package.json → docs/package.json
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
     "build": "vite build --out-dir dist",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
-    "postinstall": "npm install --prefix ./doc"
+    "postinstall": "npm install --prefix ./docs"
   },
   "dependencies": {
     "@codemirror/lang-markdown": "^6.2.2",