Skip to content

Commit 0ea02a5

Browse files
committed
added advanced topics
1 parent 4ff4fd1 commit 0ea02a5

File tree

10 files changed

+4432
-16
lines changed

10 files changed

+4432
-16
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,5 @@ ebee
4343
.Spotlight-V100
4444
.Trashes
4545
ehthumbs.db
46-
Thumbs.db
46+
Thumbs.db
47+
venv/

Makefile

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: all update upgrade install_llvm install_clang install_bpftool install_go install_bpftrace set_path source_profile build generate clean
1+
.PHONY: all update upgrade install_llvm install_clang install_bpftool install_go install_bpftrace set_path source_profile build generate clean docs-install docs-serve docs-build docs-deploy docs-clean docs-help
22

33
install: update upgrade install_llvm install_clang install_go install_bpftrace install_bpftool set_path source_profile
44

@@ -78,3 +78,45 @@ create-tool:
7878
echo "3. Update Makefile generate target"; \
7979
echo "4. Update cmd/root.go to add the command"; \
8080
echo "5. Customize docs/tools/$$toolname.md"
81+
82+
# Documentation targets
83+
docs-install:
84+
@echo "Installing MkDocs and dependencies..."
85+
pip3 install mkdocs-material
86+
pip3 install mkdocs-mermaid2-plugin
87+
@echo "✅ MkDocs installation complete"
88+
89+
docs-serve: docs-install
90+
@echo "🚀 Starting MkDocs development server..."
91+
@echo "📖 Documentation will be available at: http://127.0.0.1:8000"
92+
@echo "📝 Edit files in docs/ and see changes in real-time"
93+
@echo "🛑 Press Ctrl+C to stop the server"
94+
mkdocs serve
95+
96+
docs-build: docs-install
97+
@echo "🔨 Building static documentation..."
98+
mkdocs build
99+
@echo "✅ Documentation built in site/ directory"
100+
101+
docs-deploy: docs-build
102+
@echo "🚀 Deploying documentation to GitHub Pages..."
103+
mkdocs gh-deploy --force
104+
@echo "✅ Documentation deployed successfully"
105+
106+
docs-clean:
107+
@echo "🧹 Cleaning documentation build files..."
108+
rm -rf site/
109+
@echo "✅ Documentation build files cleaned"
110+
111+
# Help target for documentation
112+
docs-help:
113+
@echo "📚 Documentation Commands:"
114+
@echo ""
115+
@echo " make docs-install - Install MkDocs and dependencies"
116+
@echo " make docs-serve - Run local development server (http://127.0.0.1:8000)"
117+
@echo " make docs-build - Build static documentation"
118+
@echo " make docs-deploy - Deploy to GitHub Pages"
119+
@echo " make docs-clean - Clean build files"
120+
@echo " make docs-help - Show this help"
121+
@echo ""
122+
@echo "💡 Quick start: Run 'make docs-serve' to view docs locally"

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,31 @@ Each tool should include:
134134

135135
## 📖 Documentation
136136

137-
Detailed documentation for each tool and eBPF concepts can be found in the `docs/` folder:
138-
139-
- [Development Setup](docs/development-setup.md)
140-
- [eBPF Fundamentals](docs/ebpf-fundamentals.md)
141-
- [Tool Documentation](docs/tools/)
142-
- [rmdetect](docs/tools/rmdetect.md)
143-
- [execsnoop](docs/tools/execsnoop.md)
137+
Comprehensive documentation covering everything from basics to advanced production deployment:
138+
139+
### 📚 **Learning Materials**
140+
- **[Complete Documentation](docs/)** - Full learning guide
141+
- **[Getting Started](docs/getting-started/what-is-ebpf.md)** - Environment setup and eBPF introduction
142+
- **[Core Concepts](docs/fundamentals/concepts.md)** - eBPF fundamentals and architecture
143+
- **[First Tool Tutorial](docs/first-tool/architecture.md)** - Step-by-step tool creation
144+
145+
### 🚀 **Advanced Topics**
146+
- **[CO-RE & BTF](docs/advanced/core-btf.md)** - Portable eBPF development with CO-RE
147+
- **[Network Programming](docs/advanced/network-ebpf.md)** - XDP, TC, packet processing
148+
- **[Security Monitoring](docs/advanced/security-monitoring.md)** - LSM hooks, security events
149+
- **[Testing Strategies](docs/advanced/testing.md)** - Unit/integration testing frameworks
150+
- **[Performance Optimization](docs/advanced/performance.md)** - Production optimization techniques
151+
152+
### 🛠️ **Tool Documentation**
153+
- **[execsnoop](docs/tools/execsnoop.md)** - Process execution monitoring
154+
- **[rmdetect](docs/tools/rmdetect.md)** - File deletion detection
155+
- **[Network Tools](docs/advanced/network-ebpf.md)** - DDoS protection, load balancing
156+
- **[Security Tools](docs/advanced/security-monitoring.md)** - File access, process monitoring
157+
158+
### 📋 **Reference & Troubleshooting**
159+
- **[Troubleshooting Guide](docs/reference/troubleshooting.md)** - Debug techniques, common issues
160+
- **[Best Practices](docs/reference/best-practices.md)** - Production deployment patterns
161+
- **[API Reference](docs/reference/api.md)** - Helper functions and APIs
144162

145163
## 🏗️ Project Structure
146164

0 commit comments

Comments
 (0)