Skip to content

Commit 6da5d99

Browse files
committed
Improved and simplified documentation gh action
1 parent 1721017 commit 6da5d99

17 files changed

+119
-330
lines changed

.github/workflows/api-docs.yml

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,51 +7,50 @@ on:
77
- master
88
paths:
99
- 'docs/**'
10+
- 'mkdocs.yml'
1011
- '.github/workflows/api-docs.yml'
1112
workflow_dispatch:
1213

1314
permissions:
14-
contents: read
1515
pages: write
1616
id-token: write
1717

1818
concurrency:
1919
group: pages
20-
cancel-in-progress: true
20+
cancel-in-progress: false
2121

2222
jobs:
23-
deploy:
24-
name: Deploy to GitHub Pages
23+
build:
24+
name: Build Documentation
2525
runs-on: ubuntu-latest
26-
environment:
27-
name: github-pages
28-
url: ${{ steps.deployment.outputs.page_url }}
2926
steps:
3027
- name: Checkout code
3128
uses: actions/checkout@v4
3229

33-
- name: Setup Ruby
34-
uses: ruby/setup-ruby@v1
30+
- name: Set up Python
31+
uses: actions/setup-python@v5
3532
with:
36-
ruby-version: '3.3'
37-
bundler-cache: true
38-
working-directory: docs
33+
python-version: '3.x'
34+
35+
- name: Install dependencies
36+
run: pip install mkdocs-material
3937

40-
- name: Build site with Jekyll
41-
run: bundle exec jekyll build --source docs --destination _site
42-
env:
43-
JEKYLL_ENV: production
38+
- name: Build site
39+
run: mkdocs build --strict
4440

45-
- name: Upload Pages artifact
41+
- name: Upload artifact
4642
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: site
4745

46+
deploy:
47+
name: Deploy to GitHub Pages
48+
needs: build
49+
runs-on: ubuntu-latest
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
steps:
4854
- name: Deploy to GitHub Pages
4955
id: deployment
5056
uses: actions/deploy-pages@v4
51-
52-
- name: Summary
53-
run: |
54-
echo "## Docs Deployed" >> $GITHUB_STEP_SUMMARY
55-
echo "" >> $GITHUB_STEP_SUMMARY
56-
PAGE_URL="${{ steps.deployment.outputs.page_url }}"
57-
echo "Documentation deployed to: $PAGE_URL" >> $GITHUB_STEP_SUMMARY

docs/ARCHITECTURE.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: Architecture
4-
---
5-
61
# Architecture
72

83
This codebase is a legacy PHP application that has been partially modernized with Slim 4

docs/Gemfile

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

docs/_config.yml

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

docs/guides/backing-up-to-google-drive-with-rclone.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: Backing up to Google Drive with Rclone on Ubuntu
4-
---
5-
61
# Backing up to Google Drive with Rclone on Ubuntu
72

83
## 1. Install Rclone

docs/guides/backing-up-to-remote-server.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: Backing up LIS or STS to a Remote Backup Server
4-
---
5-
61
# Backing up LIS or STS to a Remote Backup Server
72

83
## Step 1: Download the Script

docs/guides/fix-collation-issue.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: Fix Illegal/Mismatched Collation Issue
4-
---
5-
61
# Fix Illegal/Mismatched Collation Issue
72

83
This guide provides steps to resolve collation mismatches in the VLSM database using phpMyAdmin by standardizing all tables and columns to use `utf8mb4_general_ci` collation.

docs/guides/installing-intelis-on-ubuntu.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: Installing InteLIS on Ubuntu 22.04 or above (only Ubuntu LTS)
4-
---
5-
61
# Installing InteLIS on Ubuntu 22.04 or above (only Ubuntu LTS)
72

83
**Important:** This installation works exclusively on Ubuntu 22.04 or later LTS versions.

docs/guides/installing-vlsm-on-windows.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: Installing VLSM on a Windows Machine
4-
---
5-
61
# Installing VLSM on a Windows Machine
72

83
## 0. Download

docs/guides/migrating-ubuntu-machines.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: Migrating From One Ubuntu Machine to Another
4-
---
5-
61
# Migrating From One Ubuntu Machine to Another
72

83
## Backup Database on Old System

0 commit comments

Comments
 (0)