Skip to content

Commit 0326923

Browse files
ADefWebserverADefWebserver
authored
Merge pull request #27 from Blazor-Data-Orchestrator/copilot/update-wiki-with-stub-pages
Add wiki stub pages with automated synchronization
2 parents ebf44c0 + 9571353 commit 0326923

File tree

13 files changed

+224
-0
lines changed

13 files changed

+224
-0
lines changed

‎.github/workflows/update-wiki.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Update Wiki
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
paths:
7+
- 'wiki-content/**'
8+
branches:
9+
- main
10+
11+
jobs:
12+
update-wiki:
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: write # Required to push to wiki repository
16+
steps:
17+
- name: Checkout main repository
18+
uses: actions/checkout@v4
19+
20+
- name: Checkout wiki repository
21+
uses: actions/checkout@v4
22+
with:
23+
repository: ${{ github.repository }}.wiki
24+
path: wiki
25+
26+
- name: Copy wiki content
27+
run: |
28+
if [ -d "wiki-content" ] && [ "$(ls -A wiki-content)" ]; then
29+
cp -r wiki-content/* wiki/
30+
else
31+
echo "Error: wiki-content directory is empty or does not exist"
32+
exit 1
33+
fi
34+
35+
- name: Commit and push wiki changes
36+
working-directory: wiki
37+
run: |
38+
git config user.name "github-actions[bot]"
39+
git config user.email "github-actions[bot]@users.noreply.github.com"
40+
git add .
41+
if git diff --staged --quiet; then
42+
echo "No changes to commit"
43+
else
44+
git commit -m "Update wiki pages from wiki-content directory"
45+
git push
46+
fi

‎WIKI_STUB_PAGES.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Wiki Stub Pages Implementation
2+
3+
This document describes the wiki stub pages implementation for the Blazor Data Orchestrator wiki.
4+
5+
## Solution Overview
6+
7+
The wiki stub pages have been created and integrated into the repository with an automated synchronization system.
8+
9+
## Implementation Details
10+
11+
### 1. Wiki Content Directory
12+
All wiki pages are now stored in the `wiki-content/` directory in the main repository. This allows:
13+
- Version control of wiki content alongside the codebase
14+
- Pull request reviews for wiki changes
15+
- Automated synchronization to the GitHub wiki
16+
17+
### 2. Pages Created
18+
19+
The following stub pages were created based on the structure defined in [Home.md](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Home):
20+
21+
1. **Features.md** - Describes the features of Blazor Data Orchestrator
22+
2. **Requirements.md** - System requirements for Blazor Data Orchestrator
23+
3. **Installation.md** - Installation instructions
24+
4. **Operation.md** - How to operate the application
25+
5. **Job-Development.md** - Parent page for job development with links to Online and Visual Studio methods
26+
6. **Online.md** - Online job development guide
27+
7. **Deployment.md** - Deployment instructions
28+
8. **Frequently-Asked-Questions.md** - FAQ page
29+
30+
### 3. Existing Pages
31+
- **Visual-Studio.md** - Already existed (screenshot of Visual Studio)
32+
- **Home.md** - Main wiki page with navigation structure
33+
34+
### 4. Stub Page Format
35+
Each stub page contains:
36+
- A title (# heading)
37+
- A brief description of the page's purpose
38+
- A "(Content to be added)" placeholder for future content
39+
40+
## Automated Synchronization
41+
42+
A GitHub Actions workflow (`.github/workflows/update-wiki.yml`) has been created that will:
43+
- Automatically sync changes from `wiki-content/` to the GitHub wiki
44+
- Trigger on pushes to the `main` branch that modify files in `wiki-content/`
45+
- Can be manually triggered via the Actions tab
46+
47+
## How the Wiki Sync Works
48+
49+
### Automated (Recommended)
50+
Once this PR is merged to `main`:
51+
1. The GitHub Actions workflow will automatically detect changes in `wiki-content/`
52+
2. It will clone the wiki repository
53+
3. Copy all files from `wiki-content/` to the wiki
54+
4. Commit and push the changes
55+
56+
### Manual Sync (If Needed)
57+
If you need to manually sync the wiki before merging:
58+
1. Go to the Actions tab in the GitHub repository
59+
2. Select "Update Wiki" workflow
60+
3. Click "Run workflow" and select the branch
61+
4. The workflow will sync the current `wiki-content/` to the wiki
62+
63+
### Direct Push (For CI/Testing)
64+
The wiki changes were also committed locally during the build at:
65+
`/home/runner/work/BlazorDataOrchestrator/BlazorDataOrchestrator.wiki/`
66+
67+
This is only relevant in the CI environment. For manual wiki updates, use the automated sync methods above.
68+
69+
## Status
70+
✅ All stub pages created
71+
✅ Wiki content copied to main repository (`wiki-content/` directory)
72+
✅ GitHub Actions workflow created for automated sync
73+
✅ Documentation created (`wiki-content/README.md`)
74+
⏳ Awaiting merge to main branch for automatic wiki sync

‎wiki-content/Deployment.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Deployment
2+
3+
This page describes how to deploy Blazor Data Orchestrator.
4+
5+
(Content to be added)

‎wiki-content/Features.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Features
2+
3+
This page describes the features of Blazor Data Orchestrator.
4+
5+
(Content to be added)

‎wiki-content/Frequently-Asked-Questions.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Frequently Asked Questions
2+
3+
This page contains frequently asked questions about Blazor Data Orchestrator.
4+
5+
(Content to be added)

‎wiki-content/Home.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Welcome to the Blazor Data Orchestrator wiki!
2+
3+
* [Features]
4+
* [Requirements]
5+
* [Installation]
6+
* [Operation]
7+
* [Job Development]
8+
- [Online]
9+
- [Visual Studio](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Visual-Studio)
10+
* [Deployment]
11+
* [Frequently Asked Questions]

‎wiki-content/Installation.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Installation
2+
3+
This page describes how to install Blazor Data Orchestrator.
4+
5+
(Content to be added)

‎wiki-content/Job-Development.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Job Development
2+
3+
This page describes how to develop jobs for Blazor Data Orchestrator.
4+
5+
## Development Options
6+
7+
* [Online](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Online) - Develop jobs using the online editor
8+
* [Visual Studio](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Visual-Studio) - Develop jobs using Visual Studio
9+
10+
(Content to be added)

‎wiki-content/Online.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Online Job Development
2+
3+
This page describes how to develop jobs using the online editor in Blazor Data Orchestrator.
4+
5+
(Content to be added)

‎wiki-content/Operation.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Operation
2+
3+
This page describes how to operate Blazor Data Orchestrator.
4+
5+
(Content to be added)

0 commit comments

Comments
 (0)