# containerd/project architecture

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

- Interactive diagram: https://gitdiagram.com/containerd/project
- Repository: https://github.com/containerd/project

## Overview

##### Project type and purpose
- This is not a running application or service but a “documentation & governance” repository for the containerd organization.
- Its sole purpose is to act as the single source of truth for:
– Project governance (GOVERNANCE.md)
– Maintainer list (MAINTAINERS)
– Contributing guidelines (CONTRIBUTING.md)
– Security policies (SECURITY.md + SECURITY_ADVISORS)
– Related boilerplate (LICENSE, EMERITUS.md, SIG-NODE.md)
- It also holds the CI configuration template under .github/workflows/ci.yml and a go.mod to tag this repo as a Go module.

##### File structure
- Top-level files:
– Markdown docs: README.md, GOVERNANCE.md, CONTRIBUTING.md, etc.
– CI config: .github/workflows/ci.yml
– Go module descriptor: go.mod
– Image assets folder: img/
- No src/ or lib/: there is no service code, only docs and config.
- CI workflow is a wrapper that pulls in “project-checks” actions from the external project-checks repo.
- README points to external sub-repos for release-tool and CI checks.

##### README for additional insights
- Explicitly states this repo contains core governance docs and points to:
– release-tool repository (github.com/containerd/release-tool)
– project-checks repository (github.com/containerd/project-checks)
- Describes how other containerd subprojects should reference these docs.

## Diagram (Mermaid)

```mermaid
flowchart TD
    Org["containerd GitHub Org"]:::external
    Repo["Project Repo\n(Knowledge Hub)"]:::inRepo

    subgraph "Core Documents & Config"
        GOV["GOVERNANCE.md"]:::inRepo
        MAINT["MAINTAINERS"]:::inRepo
        CONTRIB["CONTRIBUTING.md"]:::inRepo
        SEC["SECURITY.md"]:::inRepo
        SEC_ADVISORS["SECURITY_ADVISORS"]:::inRepo
        LIC["LICENSE"]:::inRepo
        EMERITUS["EMERITUS.md"]:::inRepo
        SIG_NODE["SIG-NODE.md"]:::inRepo
        README["README.md"]:::inRepo
        IMG["img/"]:::inRepo
        GO_MOD["go.mod"]:::inRepo
        CI[".github/workflows/ci.yml"]:::inRepo
    end

    subgraph "External Tool Repos"
        RT["release-tool"]:::external
        PC["project-checks"]:::external
    end

    Consumers["Downstream Sub-projects"]:::consumers

    Org -->|"hosts"| Repo
    Repo -->|"contains"| GOV
    Repo -->|"contains"| MAINT
    Repo -->|"contains"| CONTRIB
    Repo -->|"contains"| SEC
    Repo -->|"contains"| SEC_ADVISORS
    Repo -->|"contains"| LIC
    Repo -->|"contains"| EMERITUS
    Repo -->|"contains"| SIG_NODE
    Repo -->|"entry point"| README
    Repo -->|"assets"| IMG
    Repo -->|"module descriptor"| GO_MOD
    Repo -->|"CI pipeline"| CI

    CI -->|"invokes action"| PC
    README -->|"links to"| RT
    README -->|"links to"| PC
    Consumers -->|"reference docs"| Repo

    click GOV "https://github.com/containerd/project/blob/main/GOVERNANCE.md"
    click MAINT "https://github.com/containerd/project/tree/main/MAINTAINERS"
    click CONTRIB "https://github.com/containerd/project/blob/main/CONTRIBUTING.md"
    click SEC "https://github.com/containerd/project/blob/main/SECURITY.md"
    click SEC_ADVISORS "https://github.com/containerd/project/tree/main/SECURITY_ADVISORS"
    click LIC "https://github.com/containerd/project/tree/main/LICENSE"
    click EMERITUS "https://github.com/containerd/project/blob/main/EMERITUS.md"
    click SIG_NODE "https://github.com/containerd/project/blob/main/SIG-NODE.md"
    click README "https://github.com/containerd/project/blob/main/README.md"
    click IMG "https://github.com/containerd/project/tree/main/img/"
    click GO_MOD "https://github.com/containerd/project/blob/main/go.mod"
    click CI "https://github.com/containerd/project/blob/main/.github/workflows/ci.yml"

    classDef inRepo fill:#EBF4FF,stroke:#3182CE,color:#2C5282
    classDef external fill:#F0FFF4,stroke:#38A169,color:#276749
    classDef consumers fill:#FFF5E6,stroke:#DD6B20,color:#C05621
```
