Skip to content

Commit e8e33c9

Browse files
stacksimplifystacksimplify
committed
Welcome to StackSimplify
1 parent 819b359 commit e8e33c9

9 files changed

Lines changed: 906 additions & 0 deletions

File tree

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

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Deploy Docsify Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- '**/README.md'
10+
- 'generate_sidebar.py'
11+
workflow_dispatch: # Allow manual trigger
12+
13+
permissions:
14+
contents: write
15+
pages: write
16+
id-token: write
17+
18+
# Allow one concurrent deployment
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: true
22+
23+
jobs:
24+
generate-and-deploy:
25+
runs-on: ubuntu-latest
26+
27+
steps:
28+
- name: 🔍 Checkout Repository
29+
uses: actions/checkout@v4
30+
with:
31+
fetch-depth: 0 # Fetch all history for proper git operations
32+
33+
- name: 🐍 Setup Python
34+
uses: actions/setup-python@v4
35+
with:
36+
python-version: '3.11'
37+
38+
- name: 📝 Generate Sidebar
39+
run: |
40+
echo "🚀 Generating sidebar from repository structure..."
41+
python generate_sidebar.py
42+
echo "✅ Sidebar generated successfully!"
43+
44+
- name: 📊 Show Changes
45+
run: |
46+
echo "📋 Changes to _sidebar.md:"
47+
git diff docs/_sidebar.md || echo "No changes to sidebar"
48+
49+
- name: 💾 Commit Updated Sidebar
50+
run: |
51+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
52+
git config --local user.name "github-actions[bot]"
53+
54+
if git diff --quiet docs/_sidebar.md; then
55+
echo "✅ No changes to commit"
56+
else
57+
git add docs/_sidebar.md
58+
git commit -m "📝 Auto-update sidebar [skip ci]"
59+
git push
60+
echo "✅ Sidebar updated and pushed"
61+
fi
62+
63+
- name: 🚀 Deploy to GitHub Pages
64+
uses: peaceiris/actions-gh-pages@v3
65+
with:
66+
github_token: ${{ secrets.GITHUB_TOKEN }}
67+
publish_dir: ./docs
68+
publish_branch: gh-pages
69+
user_name: 'github-actions[bot]'
70+
user_email: 'github-actions[bot]@users.noreply.github.com'
71+
commit_message: '🚀 Deploy documentation - ${{ github.event.head_commit.message }}'
72+
73+
- name: 📢 Deployment Summary
74+
run: |
75+
echo "## 🎉 Documentation Deployed Successfully!" >> $GITHUB_STEP_SUMMARY
76+
echo "" >> $GITHUB_STEP_SUMMARY
77+
echo "Your documentation site is now live at:" >> $GITHUB_STEP_SUMMARY
78+
echo "🔗 https://stacksimplify.github.io/devops-real-world-project-implementation-on-aws/" >> $GITHUB_STEP_SUMMARY
79+
echo "" >> $GITHUB_STEP_SUMMARY
80+
echo "### Changes" >> $GITHUB_STEP_SUMMARY
81+
echo "- Sidebar automatically regenerated from repository structure" >> $GITHUB_STEP_SUMMARY
82+
echo "- All README files are now accessible through the documentation site" >> $GITHUB_STEP_SUMMARY
83+
echo "" >> $GITHUB_STEP_SUMMARY
84+
echo "⏱️ Deployment completed at: $(date)" >> $GITHUB_STEP_SUMMARY

‎docs/.nojekyll‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This file tells GitHub Pages not to use Jekyll processing
2+
# This is required for Docsify to work properly on GitHub Pages

‎docs/README.md‎

Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
# 📖 Docsify Documentation Site
2+
3+
This folder contains the Docsify-powered documentation site for the Ultimate DevOps Real-World Project course.
4+
5+
## 🌐 Live Site
6+
7+
**Production URL:** https://stacksimplify.github.io/devops-real-world-project-implementation-on-aws/
8+
9+
## 📁 Structure
10+
11+
```
12+
docs/
13+
├── index.html # Main Docsify configuration
14+
├── _coverpage.md # Landing page/cover
15+
├── _sidebar.md # Navigation sidebar (auto-generated)
16+
├── .nojekyll # GitHub Pages configuration
17+
└── README.md # This file
18+
```
19+
20+
## 🔄 Auto-Generation
21+
22+
The sidebar (`_sidebar.md`) is **automatically generated** from the repository structure using `generate_sidebar.py` in the root directory.
23+
24+
### When Sidebar Updates
25+
26+
The sidebar is regenerated automatically via GitHub Actions when:
27+
- Any README.md file is added, modified, or deleted
28+
- New course sections are added
29+
- The `generate_sidebar.py` script is updated
30+
- Manual trigger from GitHub Actions
31+
32+
### Manual Regeneration
33+
34+
To manually regenerate the sidebar:
35+
36+
```bash
37+
# From repository root
38+
python generate_sidebar.py
39+
```
40+
41+
## 🎨 Customization
42+
43+
### Styling
44+
45+
All styling is in `index.html` within the `<style>` tag. Key CSS variables:
46+
47+
```css
48+
:root {
49+
--theme-color: #FF6B35; /* Primary brand color */
50+
--theme-color-dark: #E85D2A; /* Darker shade */
51+
--theme-color-light: #FF8C61; /* Lighter shade */
52+
--sidebar-width: 300px; /* Sidebar width */
53+
}
54+
```
55+
56+
### Plugins
57+
58+
Currently enabled plugins:
59+
- ✅ Search (full-text search across all content)
60+
- ✅ Pagination (prev/next navigation)
61+
- ✅ Copy Code (copy button for code blocks)
62+
- ✅ Zoom Image (click to zoom images)
63+
- ✅ Emoji (emoji support)
64+
- ✅ Syntax Highlighting (for multiple languages)
65+
66+
To add more plugins, add the script tag in `index.html`.
67+
68+
### Cover Page
69+
70+
Edit `_coverpage.md` to update:
71+
- Course description
72+
- Key features
73+
- Statistics
74+
- Call-to-action buttons
75+
76+
## 🚀 Local Development
77+
78+
### Option 1: Using Docsify CLI (Recommended)
79+
80+
```bash
81+
# Install docsify-cli globally
82+
npm i docsify-cli -g
83+
84+
# Serve the docs locally
85+
cd docs
86+
docsify serve
87+
88+
# Open http://localhost:3000
89+
```
90+
91+
### Option 2: Using Python HTTP Server
92+
93+
```bash
94+
# From docs directory
95+
python -m http.server 3000
96+
97+
# Open http://localhost:3000
98+
```
99+
100+
### Option 3: Using VS Code Live Server
101+
102+
1. Install "Live Server" extension in VS Code
103+
2. Right-click on `docs/index.html`
104+
3. Select "Open with Live Server"
105+
106+
## 📝 Content Management
107+
108+
### Adding New Sections
109+
110+
1. Create your section folder in repo root (e.g., `19_NEW_SECTION/`)
111+
2. Add README.md files in subdirectories
112+
3. Update `SECTIONS` list in `generate_sidebar.py`
113+
4. Commit and push - sidebar auto-updates!
114+
115+
### Best Practices
116+
117+
- ✅ Keep README.md files focused and well-structured
118+
- ✅ Use relative links within README files
119+
- ✅ Include images in appropriate folders
120+
- ✅ Use markdown features (tables, code blocks, lists)
121+
- ✅ Add emojis for visual appeal
122+
- ❌ Don't edit `_sidebar.md` manually (it's auto-generated)
123+
124+
## 🔍 Search Configuration
125+
126+
Search is configured to:
127+
- Index all content automatically
128+
- Cache for 1 day (improves performance)
129+
- Search depth of 6 levels
130+
- Highlight matches
131+
- Show context around matches
132+
133+
## 📱 Mobile Responsiveness
134+
135+
The site is fully responsive and works great on:
136+
- 📱 Mobile phones
137+
- 📱 Tablets
138+
- 💻 Laptops
139+
- 🖥️ Desktop monitors
140+
141+
## 🐛 Troubleshooting
142+
143+
### Sidebar not updating
144+
145+
```bash
146+
# Manually regenerate
147+
python generate_sidebar.py
148+
149+
# Check GitHub Actions logs
150+
# Go to: Repository → Actions → Deploy Docsify Documentation
151+
```
152+
153+
### Images not loading
154+
155+
Ensure image paths are correct:
156+
```markdown
157+
<!-- Relative to README location -->
158+
![diagram](./images/architecture.png)
159+
160+
<!-- Absolute from docs root -->
161+
![logo](/images/logo.png)
162+
```
163+
164+
### 404 errors
165+
166+
- Ensure `.nojekyll` file exists in docs folder
167+
- Check that file paths match exactly (case-sensitive)
168+
- Verify GitHub Pages is enabled in repo settings
169+
170+
## 🛠️ Advanced Configuration
171+
172+
### Adding Google Analytics
173+
174+
Edit `index.html` and uncomment the Google Analytics section:
175+
176+
```html
177+
<script async src="https://www.googletagmanager.com/gtag/js?id=YOUR-GA-ID"></script>
178+
<script>
179+
window.dataLayer = window.dataLayer || [];
180+
function gtag(){dataLayer.push(arguments);}
181+
gtag('js', new Date());
182+
gtag('config', 'YOUR-GA-ID');
183+
</script>
184+
```
185+
186+
### Custom Domain
187+
188+
To use a custom domain:
189+
190+
1. Add CNAME file in docs folder:
191+
```
192+
docs.stacksimplify.com
193+
```
194+
195+
2. Configure DNS with your provider:
196+
```
197+
CNAME docs.stacksimplify.com stacksimplify.github.io
198+
```
199+
200+
3. Enable custom domain in GitHub Pages settings
201+
202+
## 📊 Performance
203+
204+
The site is optimized for performance:
205+
- ✅ No build step required (instant updates)
206+
- ✅ CDN-hosted assets
207+
- ✅ Lazy loading of content
208+
- ✅ Search index caching
209+
- ✅ Minimal JavaScript
210+
211+
## 🤝 Contributing
212+
213+
To contribute to the documentation:
214+
215+
1. Edit relevant README.md files in course sections
216+
2. Test locally using `docsify serve`
217+
3. Commit and push changes
218+
4. GitHub Actions will auto-deploy
219+
220+
## 📚 Resources
221+
222+
- [Docsify Documentation](https://docsify.js.org/)
223+
- [Docsify Themes](https://docsify.js.org/#/themes)
224+
- [Docsify Plugins](https://docsify.js.org/#/plugins)
225+
- [Markdown Guide](https://www.markdownguide.org/)
226+
227+
## 📧 Support
228+
229+
For issues or questions:
230+
- 📧 Email: support@stacksimplify.com
231+
- 🐙 GitHub Issues: [Create an issue](https://github.com/stacksimplify/devops-real-world-project-implementation-on-aws/issues)
232+
- 💬 LinkedIn: [Kalyan Reddy Daida](https://www.linkedin.com/in/kalyan-reddy-daida/)
233+
234+
---
235+
236+
Made with ❤️ by [Stack Simplify](https://stacksimplify.com)

‎docs/_coverpage.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!-- _coverpage.md -->
2+
3+
![logo](https://stacksimplify.com/course-images/udemy-ultimate-devops-realworld-implementation-on-aws.png)
4+
5+
# Ultimate DevOps Course
6+
7+
> Production-Ready DevOps Implementation on AWS Cloud
8+
9+
The most comprehensive, hands-on DevOps course with 55+ real-world demonstrations. Learn production-grade implementations that will transform how you deploy and manage applications on AWS.
10+
11+
## 🎯 What You'll Master
12+
13+
- 🐳 **Docker Mastery** - From basics to multi-stage builds and optimization
14+
- 🏗️ **Infrastructure as Code** - Complete Terraform implementations for VPC, EKS, and more
15+
- ☸️ **Kubernetes on EKS** - Production-ready cluster management
16+
- ⚡ **Karpenter Autoscaling** - Smart, cost-efficient node autoscaling
17+
- 📊 **Complete Observability** - OpenTelemetry, AWS X-Ray, CloudWatch integration
18+
- 🔄 **GitOps with ArgoCD** - Automated, declarative deployments
19+
- 🚀 **CI/CD Pipeline** - GitHub Actions from scratch to production
20+
- 💰 **Cost Optimization** - Reduce AWS costs from $21/day to $3/day (85% savings!)
21+
22+
## 💡 Real-World Focus
23+
24+
Unlike theoretical courses, this teaches **production-ready implementations**:
25+
- ✅ Actual microservices application (Retail Store with 5+ services)
26+
- ✅ Real cost optimization strategies
27+
- ✅ Production-grade security and networking
28+
- ✅ Spot instances with zero-downtime interruption handling
29+
- ✅ Complete CI/CD automation
30+
- ✅ Full observability stack with traces, metrics, and logs
31+
32+
## 📚 Course Stats
33+
34+
- **21 Major Sections**
35+
- **55+ Hands-on Demos**
36+
- **6 Months** of Development Work
37+
- **Production-Ready** Implementations
38+
- **Cost-Effective** Solutions
39+
40+
## 🎓 Who Is This For?
41+
42+
- DevOps Engineers looking to master AWS implementations
43+
- Cloud Engineers wanting hands-on Kubernetes experience
44+
- Developers ready to own the entire deployment pipeline
45+
- Teams seeking to reduce infrastructure costs significantly
46+
- Anyone wanting production-ready DevOps skills
47+
48+
[🐙 GitHub Repository](https://github.com/stacksimplify/devops-real-world-project-implementation-on-aws)
49+
[📖 Get Started](#ultimate-devops-course)
50+
51+
<!-- Background gradient -->
52+
![color](#667eea)

‎docs/_sidebar.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- Auto-generated by generate_sidebar.py -->
2+
<!-- Do not edit manually - run the script to regenerate -->
3+
4+
# 📖 Course Navigation
5+
6+
- [🏠 Home](/README.md)
7+
8+
---
9+
10+
- **📚 Resources**
11+
- [GitHub Repository](https://github.com/stacksimplify/devops-real-world-project-implementation-on-aws)
12+
- [Stack Simplify](https://stacksimplify.com)
13+
- [YouTube Channel](https://www.youtube.com/@stacksimplify)
14+
- [LinkedIn](https://www.linkedin.com/in/kalyan-reddy-daida/)

0 commit comments

Comments
 (0)