Skip to content

Commit a05216e

Browse files
committed
refactor: streamline documentation and configuration for eBPF project
Removed unnecessary plugins from mkdocs.yml to simplify the documentation setup. Introduced requirements-docs.txt to manage MkDocs and related dependencies. Added GitHub Actions workflow for automated documentation deployment. Created comprehensive contributing guide and templates to facilitate community contributions. Enhanced the first tool and fundamentals documentation for better clarity and structure.
1 parent 1c6b4c8 commit a05216e

File tree

12 files changed

+2427
-5
lines changed

12 files changed

+2427
-5
lines changed

.github/workflows/docs.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Deploy MkDocs Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
paths:
7+
- 'docs/**'
8+
- 'mkdocs.yml'
9+
- '.github/workflows/docs.yml'
10+
pull_request:
11+
branches: [ main ]
12+
paths:
13+
- 'docs/**'
14+
- 'mkdocs.yml'
15+
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
21+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
22+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
23+
concurrency:
24+
group: "pages"
25+
cancel-in-progress: false
26+
27+
jobs:
28+
# Build job
29+
build:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
with:
35+
# Fetch full history for git-related plugins (if we add them later)
36+
fetch-depth: 0
37+
38+
- name: Setup Python
39+
uses: actions/setup-python@v4
40+
with:
41+
python-version: '3.11'
42+
cache: 'pip'
43+
44+
- name: Install MkDocs and dependencies
45+
run: |
46+
pip install -r requirements-docs.txt
47+
48+
- name: Build MkDocs site
49+
run: mkdocs build --verbose --clean --strict
50+
51+
- name: Upload Pages artifact
52+
uses: actions/upload-pages-artifact@v2
53+
with:
54+
path: ./site
55+
56+
# Deployment job (only runs on main branch)
57+
deploy:
58+
if: github.ref == 'refs/heads/main'
59+
environment:
60+
name: github-pages
61+
url: ${{ steps.deployment.outputs.page_url }}
62+
runs-on: ubuntu-latest
63+
needs: build
64+
steps:
65+
- name: Deploy to GitHub Pages
66+
id: deployment
67+
uses: actions/deploy-pages@v2

0 commit comments

Comments
 (0)