Skip to content

Commit e781093

Browse files
rakeshl4rakeshl4
committed
install mike to support multiple configs
1 parent edc23ce commit e781093

6 files changed

Lines changed: 260 additions & 3 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ jobs:
1515
runs-on: ubuntu-latest
1616
steps:
1717
- uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0 # Fetch all history for mike versioning
1820
- name: Configure Git Credentials
1921
run: |
2022
git config user.name github-actions[bot]
@@ -29,5 +31,9 @@ jobs:
2931
path: .cache
3032
restore-keys: |
3133
mkdocs-material-
32-
- run: pip install mkdocs-material mkdocs-glightbox mkdocs-include-markdown-plugin
33-
- run: mkdocs gh-deploy --force --config-file docs/mkdocs.yml
34+
- run: pip install mkdocs-material mkdocs-glightbox mkdocs-include-markdown-plugin mike
35+
- name: Deploy with mike
36+
run: |
37+
# Deploy latest version
38+
mike deploy --push --update-aliases latest default
39+
mike set-default --push latest

‎docs/DEPLOYMENT.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Multi-Version Workshop Documentation
2+
3+
This workshop uses [mike](https://github.com/jimporter/mike) to manage multiple versions of the documentation for different events and skill levels.
4+
5+
## Available Configurations
6+
7+
- **mkdocs.yml** - Full workshop with all labs (default)
8+
- **mkdocs-beginner.yml** - Beginner track (Labs 1-3)
9+
- **mkdocs-advanced.yml** - Advanced track (Labs 3.1-5)
10+
11+
## Deploying Different Versions
12+
13+
### Deploy to a specific version path
14+
15+
```bash
16+
# Deploy beginner version
17+
mike deploy beginner --config-file docs/mkdocs-beginner.yml --push
18+
19+
# Deploy advanced version
20+
mike deploy advanced --config-file docs/mkdocs-advanced.yml --push
21+
22+
# Deploy event-specific version
23+
mike deploy ignite-2026 --config-file docs/mkdocs.yml --push
24+
```
25+
26+
### Set default version
27+
28+
```bash
29+
mike set-default latest --push
30+
```
31+
32+
### List all deployed versions
33+
34+
```bash
35+
mike list
36+
```
37+
38+
### Delete a version
39+
40+
```bash
41+
mike delete <version-name> --push
42+
```
43+
44+
## Accessing Different Versions
45+
46+
After deployment, versions will be available at:
47+
48+
- `https://yourname.github.io/agent-builder-workshop/` (default/latest)
49+
- `https://yourname.github.io/agent-builder-workshop/beginner/`
50+
- `https://yourname.github.io/agent-builder-workshop/advanced/`
51+
- `https://yourname.github.io/agent-builder-workshop/ignite-2026/`
52+
53+
## Local Development
54+
55+
Test a specific configuration locally:
56+
57+
```bash
58+
mkdocs serve -f docs/mkdocs-beginner.yml
59+
mkdocs serve -f docs/mkdocs-advanced.yml
60+
```
61+
62+
## Creating New Event Versions
63+
64+
1. Copy an existing config file:
65+
```bash
66+
cp docs/mkdocs.yml docs/mkdocs-myevent-2026.yml
67+
```
68+
69+
2. Update the `site_name` and customize the `nav` section
70+
71+
3. Deploy with mike:
72+
```bash
73+
mike deploy myevent-2026 --config-file docs/mkdocs-myevent-2026.yml --push
74+
```
75+
76+
## GitHub Actions
77+
78+
The workflow in `.github/workflows/ci.yml` automatically deploys the latest version on push to main/master.
79+
80+
To deploy additional versions, you can:
81+
- Manually run `mike deploy` locally and push
82+
- Add version-specific workflow triggers based on branches or tags
83+
- Use workflow dispatch with parameters
84+
85+
## Version Selector
86+
87+
All deployed versions will appear in a version selector dropdown at the top of the documentation site (if using Material theme).

‎docs/mkdocs-advanced.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
site_name: AI Agent Builder Workshop - Advanced Track
2+
site_description: Advanced workshop covering error handling, human approval, and multi-agent systems using Microsoft Agent Framework.
3+
site_author: Rakesh Lakshminarayanana
4+
site_url: https://binarytrails-ai.github.io/agent-builder-workshop
5+
6+
nav:
7+
- Welcome: index.md
8+
- Environment Setup: 00-setup_instructions.md
9+
- "LAB 3: Tools": 03-lab-tools.md
10+
- "LAB 3.1: Tool Error Handling": 03.1-lab-tool-error-handling.md
11+
- "LAB 4: Human Approval": 05-lab-human-approval.md
12+
- "LAB 5: Multi-Agent": 06-lab-multi-agent.md
13+
- "Finishing Up": finishing-up.md
14+
- Learning Resources: resources.md
15+
- Additional Resources:
16+
- Azure Resource Deployment: Resources/azure-resource-setup.md
17+
- Aspire Dashboard Setup: Resources/aspire-dashboard-setup.md
18+
- Feedback: feedback.md
19+
20+
plugins:
21+
- glightbox
22+
- include-markdown
23+
24+
theme:
25+
name: material
26+
logo: media/favicon.png
27+
favicon: media/favicon.png
28+
features:
29+
- navigation.instant
30+
- navigation.footer
31+
- navigation.tracking
32+
- navigation.top
33+
- content.code.copy
34+
- navigation.tabs.sticky
35+
- content.tabs.link
36+
- search.highlight
37+
- search.suggest
38+
39+
font:
40+
code: Roboto Mono
41+
text: Roboto
42+
palette:
43+
- scheme: default
44+
primary: black
45+
accent: pink
46+
toggle:
47+
icon: material/brightness-2
48+
name: Switch to dark mode
49+
- scheme: slate
50+
primary: amber
51+
accent: cyan
52+
toggle:
53+
icon: material/brightness-7
54+
name: Switch to light mode
55+
56+
markdown_extensions:
57+
- toc:
58+
permalink: true
59+
toc_depth: 2
60+
- admonition
61+
- pymdownx.details
62+
- pymdownx.superfences
63+
- pymdownx.tabbed:
64+
alternate_style: true
65+
- pymdownx.tasklist:
66+
custom_checkbox: true
67+
- attr_list
68+
- md_in_html
69+
70+
extra_css:
71+
- css/custom.css
72+
73+
extra_javascript:
74+
- js/custom-nav.js
75+
76+
extra:
77+
version:
78+
provider: mike
79+
default: latest

‎docs/mkdocs-beginner.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
site_name: AI Agent Builder Workshop - Beginner Track
2+
site_description: Beginner workshop to learn the fundamentals of building AI Agents using Microsoft Agent Framework.
3+
site_author: Rakesh Lakshminarayanana
4+
site_url: https://binarytrails-ai.github.io/agent-builder-workshop
5+
6+
nav:
7+
- Welcome: index.md
8+
- Environment Setup: 00-setup_instructions.md
9+
- "LAB 1: Personalization": 01-lab-personalization.md
10+
- "LAB 2: Memory": 02-lab-memory.md
11+
- "LAB 3: Tools": 03-lab-tools.md
12+
- "Finishing Up": finishing-up.md
13+
- Learning Resources: resources.md
14+
- Additional Resources:
15+
- Azure Resource Deployment: Resources/azure-resource-setup.md
16+
- Aspire Dashboard Setup: Resources/aspire-dashboard-setup.md
17+
- Feedback: feedback.md
18+
19+
plugins:
20+
- glightbox
21+
- include-markdown
22+
23+
theme:
24+
name: material
25+
logo: media/favicon.png
26+
favicon: media/favicon.png
27+
features:
28+
- navigation.instant
29+
- navigation.footer
30+
- navigation.tracking
31+
- navigation.top
32+
- content.code.copy
33+
- navigation.tabs.sticky
34+
- content.tabs.link
35+
- search.highlight
36+
- search.suggest
37+
38+
font:
39+
code: Roboto Mono
40+
text: Roboto
41+
palette:
42+
- scheme: default
43+
primary: black
44+
accent: pink
45+
toggle:
46+
icon: material/brightness-2
47+
name: Switch to dark mode
48+
- scheme: slate
49+
primary: amber
50+
accent: cyan
51+
toggle:
52+
icon: material/brightness-7
53+
name: Switch to light mode
54+
55+
markdown_extensions:
56+
- toc:
57+
permalink: true
58+
toc_depth: 2
59+
- admonition
60+
- pymdownx.details
61+
- pymdownx.superfences
62+
- pymdownx.tabbed:
63+
alternate_style: true
64+
- pymdownx.tasklist:
65+
custom_checkbox: true
66+
- attr_list
67+
- md_in_html
68+
69+
extra_css:
70+
- css/custom.css
71+
72+
extra_javascript:
73+
- js/custom-nav.js
74+
75+
extra:
76+
version:
77+
provider: mike
78+
default: latest

‎docs/mkdocs.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,9 @@ extra_css:
8080
# mkdocs.yml
8181
extra_javascript:
8282
- js/custom-nav.js
83+
84+
# Version selector for mike
85+
extra:
86+
version:
87+
provider: mike
88+
default: latest

‎docs/requirements.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
mkdocs
22
mkdocs-glightbox
33
mkdocs-material
4-
mkdocs-include-markdown-plugin
4+
mkdocs-include-markdown-plugin
5+
mike

0 commit comments

Comments
 (0)