# feiskyer/sdn-handbook architecture

> Architecture diagram of the GitHub repository feiskyer/sdn-handbook, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/feiskyer/sdn-handbook
- Repository: https://github.com/feiskyer/sdn-handbook

## Overview

##### Project type and purpose
- This is a static documentation website (an SDN handbook) built from Markdown source files. It uses a book/site generator (e.g., GitBook) driven by SUMMARY.md, book.json, Makefile and package.json.
- Purpose: provide an online guide covering network basics, SDN, container networking, Linux networking, OVS/DPDK, SD-WAN, NFV and practice cases.

##### File structure
- Top-level:
- README.md, SUMMARY.md, book.json, package.json, Makefile → site‐generator config & build scripts
- Directories “basic”, “container”, “dpdk”, “linux”, “mininet”, “nfv”, “ovs”, “practice”, “sdn”, “sdwan” → content chapters in Markdown plus subfolders for images/media
- “images” folder at root for shared assets
- No runtime code or databases; all “runtime” is a static web server/host.

##### README for additional insights
- Mentions online reading at sdn.feisky.xyz, GitHub repo.
- No deep architectural notes beyond site generation and content topics.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Source Code"
        GitHubRepo["GitHub Repo"]:::code
        DocumentationSource["Markdown Content"]:::code
        Assets["Shared Assets"]:::assets
    end

    subgraph "Build Process"
        CIPipeline["CI/CD Pipeline"]:::code
        SSGenerator["Static Site Generator<br/>(Makefile & Node Scripts)"]:::code
        BuildArtifacts["Build Artifacts<br/>(_book/ or dist/)"]:::assets
    end

    subgraph "Deployment"
        HostingCDN["Hosting / CDN<br/>(sdn.feisky.xyz)"]:::hosting
    end

    subgraph "End User"
        UserBrowser["User Browser"]:::user
    end

    GitHubRepo -->|push code| CIPipeline
    CIPipeline -->|trigger build| SSGenerator
    DocumentationSource -->|input content| SSGenerator
    Assets -->|input assets| SSGenerator
    SSGenerator -->|generate artifacts| BuildArtifacts
    BuildArtifacts -->|provide assets| HostingCDN
    CIPipeline -->|deploy artifacts| HostingCDN
    HostingCDN -->|serve site| UserBrowser

    click GitHubRepo "https://github.com/feiskyer/sdn-handbook/blob/master/README.md"
    click DocumentationSource "https://github.com/feiskyer/sdn-handbook/blob/master/SUMMARY.md"
    click Assets "https://github.com/feiskyer/sdn-handbook/tree/master/images/"
    click SSGenerator "https://github.com/feiskyer/sdn-handbook/tree/master/Makefile"
    click CSPipeline "https://github.com/feiskyer/sdn-handbook/tree/master/Makefile"
    click HostingCDN "https://github.com/feiskyer/sdn-handbook/blob/master/book.json"

    classDef code fill:#D0E6FF,stroke:#357ABD,color:#000;
    classDef assets fill:#D0FFD6,stroke:#28A745,color:#000;
    classDef hosting fill:#FFE0B3,stroke:#F0AD4E,color:#000;
    classDef user fill:#E0E0E0,stroke:#6C757D,color:#000;
```
