Skip to content

Commit f0e9729

Browse files
YZXBizclaude
andcommitted
Add Docusaurus documentation site with docs-template structure
- Set up Docusaurus 3.x with docs-template structure - Configure GitHub Actions workflow for GitHub Pages deployment - Organize 17 chapters into 4 parts (Fundamentals, Core Concepts, Advanced Features, Security) - Add diagram components from mlops-daily-dose with improved styling - Update all markdown links from index.md to intro.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent bd31d94 commit f0e9729

41 files changed

Lines changed: 22060 additions & 14 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- 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+
defaults:
23+
run:
24+
working-directory: ./docs
25+
steps:
26+
- uses: actions/checkout@v4
27+
- uses: actions/setup-node@v4
28+
with:
29+
node-version: 20
30+
cache: npm
31+
cache-dependency-path: ./docs/package-lock.json
32+
- run: npm ci
33+
- run: npm run build
34+
- uses: actions/configure-pages@v4
35+
- uses: actions/upload-pages-artifact@v3
36+
with:
37+
path: ./docs/build
38+
39+
deploy:
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
runs-on: ubuntu-latest
44+
needs: build
45+
steps:
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

docs/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

docs/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
## Installation
6+
7+
```bash
8+
yarn
9+
```
10+
11+
## Local Development
12+
13+
```bash
14+
yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
## Build
20+
21+
```bash
22+
yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
## Deployment
28+
29+
Using SSH:
30+
31+
```bash
32+
USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```bash
38+
GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Chapter 1: Kubernetes Primer
22

3-
**Previous:** [Index](index.md) | **Next:** [Chapter 2: Kubernetes Principles](02-kubernetes-principles.md)
3+
**Previous:** [Index](intro.md) | **Next:** [Chapter 2: Kubernetes Principles](02-kubernetes-principles.md)
44

55
---
66

@@ -316,4 +316,4 @@ Kubernetes represents more than technology advancement - it enables new organiza
316316

317317
---
318318

319-
**Previous:** [Index](index.md) | **Next:** [Chapter 2: Kubernetes Principles](02-kubernetes-principles.md)
319+
**Previous:** [Index](intro.md) | **Next:** [Chapter 2: Kubernetes Principles](02-kubernetes-principles.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,4 +469,4 @@ The restaurant manager analogy helps illustrate how Deployments orchestrate appl
469469
**Navigation:**
470470
- **Previous:** [5. Virtual Clusters with Namespaces](05-virtual-clusters-namespaces.md)
471471
- **Next:** [7. Kubernetes Services](07-kubernetes-services.md)
472-
- **Up:** [Table of Contents](index.md)
472+
- **Up:** [Table of Contents](intro.md)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,4 +466,4 @@ Services are fundamental to cloud-native architecture - they enable the loose co
466466
**Navigation:**
467467
- **Previous:** [6. Kubernetes Deployments](06-kubernetes-deployments.md)
468468
- **Next:** [8. Ingress](08-ingress.md)
469-
- **Up:** [Table of Contents](index.md)
469+
- **Up:** [Table of Contents](intro.md)

0 commit comments

Comments
 (0)