Skip to content

Commit a134cb5

Browse files
krishnasagakrishnasaga
committed
Add GitHub Actions workflow for automated MkDocs deployment
- Created .github/workflows/deploy-docs.yml for automated GitHub Pages deployment - Enhanced mkdocs.yml with advanced Material theme features and GitHub integration - Updated requirements.txt with additional MkDocs plugins - Improved README.md with comprehensive documentation overview and setup instructions - Added light/dark theme toggle, better navigation, and code copy features - Configured automatic deployment on push to main branch
1 parent 1a56011 commit a134cb5

4 files changed

Lines changed: 206 additions & 4 deletions

File tree

‎.github/workflows/deploy-docs.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v4
25+
with:
26+
fetch-depth: 0
27+
28+
- name: Setup Python
29+
uses: actions/setup-python@v4
30+
with:
31+
python-version: '3.11'
32+
cache: 'pip'
33+
34+
- name: Install dependencies
35+
run: |
36+
pip install --upgrade pip
37+
pip install -r requirements.txt
38+
39+
- name: Build MkDocs site
40+
run: mkdocs build --clean --strict
41+
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v3
44+
45+
- name: Upload artifact
46+
uses: actions/upload-pages-artifact@v2
47+
with:
48+
path: './site'
49+
50+
deploy:
51+
environment:
52+
name: github-pages
53+
url: ${{ steps.deployment.outputs.page_url }}
54+
runs-on: ubuntu-latest
55+
needs: build
56+
if: github.ref == 'refs/heads/main'
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v2

‎README.md‎

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,59 @@
1-
# notes
1+
# AWS Study Notes
2+
3+
[![Deploy MkDocs](https://github.com/resilience-tech/notes-aws/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/resilience-tech/notes-aws/actions/workflows/deploy-docs.yml)
4+
5+
Your comprehensive AWS certification study notes, automatically published to GitHub Pages using Material for MkDocs.
6+
7+
## 📚 Documentation Sections
8+
9+
- **Storage** - S3, EBS, EFS, and storage optimization
10+
- **Compute** - EC2, Lambda, containers, and serverless architectures
11+
- **Network** - VPC, load balancing, and advanced networking
12+
- **IAM** - Identity and access management fundamentals
13+
- **Databases** - RDS, DynamoDB, and database services
14+
15+
## 🚀 Live Documentation
16+
17+
The documentation is automatically built and deployed to GitHub Pages at:
18+
**https://resilience-tech.github.io/notes-aws/**
19+
20+
## 🛠️ Local Development
21+
22+
To run the documentation locally:
23+
24+
```bash
25+
# Install dependencies
26+
pip install -r requirements.txt
27+
28+
# Serve locally
29+
mkdocs serve
30+
```
31+
32+
The site will be available at `http://localhost:8000`
33+
34+
## 📝 Contributing
35+
36+
The documentation is organized into logical sections with consistent formatting:
37+
- Part 1: Fundamentals
38+
- Part 2: Intermediate concepts
39+
- Advanced: Professional-level topics
40+
- Internals: Deep technical details
41+
42+
Each section includes:
43+
- Comprehensive tables and comparisons
44+
- Code examples and CLI commands
45+
- Best practices and exam tips
46+
- Real-world scenarios and troubleshooting
47+
48+
## 🎯 Certification Focus
49+
50+
These notes are specifically structured for AWS certification preparation:
51+
- AWS Certified Solutions Architect
52+
- AWS Certified Developer
53+
- AWS Certified SysOps Administrator
54+
- AWS Certified Advanced Networking
55+
- AWS Certified Security
56+
57+
---
58+
59+
*Last updated: September 2025*

‎mkdocs.yml‎

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
site_name: AWS Notes
1+
site_name: AWS Study Notes
2+
site_description: Comprehensive AWS certification study notes with detailed coverage of all major AWS services
3+
site_author: Resilience Tech
4+
site_url: https://resilience-tech.github.io/notes-aws/
5+
repo_name: resilience-tech/notes-aws
6+
repo_url: https://github.com/resilience-tech/notes-aws
7+
edit_uri: edit/main/docs/
8+
29
nav:
310
- Storage:
411
- Part 1: storage/storage-part1.md
@@ -27,20 +34,95 @@ nav:
2734
- Internals: databases/databases-internals.md
2835
theme:
2936
name: material
37+
language: en
3038
palette:
3139
- scheme: slate
3240
primary: orange
3341
accent: deep orange
42+
toggle:
43+
icon: material/brightness-4
44+
name: Switch to light mode
45+
- scheme: default
46+
primary: orange
47+
accent: deep orange
48+
toggle:
49+
icon: material/brightness-7
50+
name: Switch to dark mode
3451
features:
3552
- navigation.tabs
3653
- navigation.top
54+
- navigation.sections
55+
- navigation.expand
56+
- navigation.instant
57+
- navigation.tracking
3758
- search.suggest
3859
- search.highlight
60+
- search.share
3961
- toc.integrate
62+
- content.code.copy
63+
- content.action.edit
64+
icon:
65+
repo: fontawesome/brands/github
66+
edit: material/pencil
4067
markdown_extensions:
4168
- admonition
42-
- codehilite
69+
- attr_list
70+
- def_list
4371
- footnotes
72+
- md_in_html
4473
- meta
74+
- tables
4575
- toc:
4676
permalink: true
77+
title: On this page
78+
- pymdownx.arithmatex:
79+
generic: true
80+
- pymdownx.betterem:
81+
smart_enable: all
82+
- pymdownx.caret
83+
- pymdownx.details
84+
- pymdownx.emoji:
85+
emoji_index: !!python/name:materialx.emoji.twemoji
86+
emoji_generator: !!python/name:materialx.emoji.to_svg
87+
- pymdownx.highlight:
88+
anchor_linenums: true
89+
line_spans: __span
90+
pygments_lang_class: true
91+
- pymdownx.inlinehilite
92+
- pymdownx.keys
93+
- pymdownx.magiclink:
94+
repo_url_shorthand: true
95+
user: resilience-tech
96+
repo: notes-aws
97+
- pymdownx.mark
98+
- pymdownx.smartsymbols
99+
- pymdownx.superfences:
100+
custom_fences:
101+
- name: mermaid
102+
class: mermaid
103+
format: !!python/name:pymdownx.superfences.fence_code_format
104+
- pymdownx.tabbed:
105+
alternate_style: true
106+
- pymdownx.tasklist:
107+
custom_checkbox: true
108+
- pymdownx.tilde
109+
110+
plugins:
111+
- search:
112+
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
113+
- minify:
114+
minify_html: true
115+
116+
extra:
117+
analytics:
118+
provider: google
119+
property: !ENV GOOGLE_ANALYTICS_KEY
120+
social:
121+
- icon: fontawesome/brands/github
122+
link: https://github.com/resilience-tech/notes-aws
123+
name: GitHub Repository
124+
generator: false
125+
126+
copyright: |
127+
Copyright © 2025 Resilience Tech –
128+
<a href="#__consent">Change cookie settings</a>

‎requirements.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
mkdocs-material
1+
mkdocs-material>=9.4.0
2+
mkdocs-minify-plugin>=0.7.0
3+
pymdown-extensions>=10.0.0

0 commit comments

Comments
 (0)