# hmntsharma/draft-ietf-grow-bmp-tcp-ao architecture

> Architecture diagram of the GitHub repository hmntsharma/draft-ietf-grow-bmp-tcp-ao, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao
- Repository: https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao

## Overview

##### Project type and purpose
- This repo is *not* a traditional full-stack application but an IETF Internet-Draft authoring and publishing workflow.
- Purpose: write and maintain the “TCP-AO Protection for BGP Monitoring Protocol (BMP)” draft, build HTML/plain-text outputs, and automate publication (GitHub Pages, Datatracker, archives).

##### File structure
- Top-level content:
- `draft-ietf-grow-bmp-tcp-ao.md` (source of the specification)
- `Makefile` (build commands)
- `.github/workflows/...` (CI/CD manifests)
- Supporting metadata: `README.md`, `CONTRIBUTING.md`, `LICENSE.md`
- No traditional “src/backend/frontend,” but there is a clear “source → build → publish” pipeline.
- Key patterns:
- A markdown source transformed by standard I-D toolchain (per `SETUP.md`)
- CI workflows for continuous publishing, archiving, license checks, and GitHub Pages deployment

##### README for additional insights
- Confirms build via `make`
- References external toolchain (I-D template)
- Points at GitHub Pages and IETF Datatracker integrations

##### Main components
a. **Authoring Environment**
- Authors write/edit `draft-*.md` locally or via GitHub Web Editor
- Local toolchain: Pandoc/iddraft scripts invoked through `make`
b. **Version Control & CI**
- GitHub Repo hosts source and workflows
- Workflows: `publish.yml` (build & deploy), `ghpages.yml` (push to Pages), `archive.yml`, `update.yml`, `LICENSE.md` check
c. **Build System**
- `Makefile` orchestrates conversion of `.md` → `.txt`/`.html`
d. **Publication Targets**
- GitHub Pages (editor’s copy)
- IETF Datatracker (individual draft)
- Archive repositories
e. **External Dependencies**
- I-D Template toolchain (martinthomson/i-d-template)
- Pandoc or other formatting tools

##### Relationships & interactions
- Author commits → pushes to GitHub → triggers CI workflows
- CI invokes `make` → generates HTML/Text artifacts
- Artifacts deployed to GitHub Pages and/or synced to IETF Datatracker via automated scripts
- LICENSE check workflow validates license file on each push
- Archive workflow captures snapshots

##### Architectural patterns & design principles
- **GitOps-style** automation: all publication steps defined as code in `.github/workflows`
- **Separation of concerns**: content (markdown) vs. build logic (`Makefile`) vs. deployment logic (CI workflows)
- **Infrastructure as code**: CI manifests declare deployment targets and triggers

##### Detail level
- Do not over-complicate: capture each unique logical component
- How content changes propagate end-to-end
- Conditional steps (e.g., license checks, archive triggers)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Local Development"
        Author["Authoring Environment"]:::external
        MD["Markdown Source"]:::storage
        README["README.md"]:::storage
        CONTRIBUTING["CONTRIBUTING.md"]:::storage
        LICENSEMeta["LICENSE.md"]:::storage
        Editorconfig[".editorconfig"]:::storage
        Gitignore[".gitignore"]:::storage
        Codeowners[".github/CODEOWNERS"]:::storage
        Makefile["Makefile"]:::compute
        ExternalTC["I-D Template Toolchain"]:::external
        Pandoc["Pandoc"]:::external
    end

    subgraph "CI Infrastructure"
        Repo["GitHub Repo"]:::storage
        PublishCI["publish.yml"]:::compute
        GHPagesCI["ghpages.yml"]:::compute
        ArchiveCI["archive.yml"]:::compute
        UpdateCI["update.yml"]:::compute
        LicenseCI["LICENSE.md Check"]:::compute
    end

    subgraph "Publishing Targets"
        HTML["HTML/Text Output"]:::output
        GHPages["GitHub Pages"]:::output
        Datatracker["IETF Datatracker"]:::output
        Archive["Archive Repo"]:::output
    end

    Author --> MD
    Author --> README
    Author --> CONTRIBUTING
    Author --> LICENSEMeta
    Author --> Editorconfig
    Author --> Gitignore
    Author --> Codeowners
    Author --> Makefile

    MD --> Repo
    README --> Repo
    CONTRIBUTING --> Repo
    LICENSEMeta --> Repo
    Editorconfig --> Repo
    Gitignore --> Repo
    Codeowners --> Repo
    Makefile --> Repo

    Repo --> PublishCI
    Repo --> GHPagesCI
    Repo --> ArchiveCI
    Repo --> UpdateCI
    Repo --> LicenseCI

    PublishCI --> Makefile
    PublishCI --> ExternalTC
    PublishCI --> Pandoc
    PublishCI --> HTML
    GHPagesCI --> HTML
    GHPagesCI --> GHPages
    PublishCI --> Datatracker
    ArchiveCI --> Archive

    classDef storage fill:#BBDEFB,stroke:#1E88E5;
    classDef compute fill:#C8E6C9,stroke:#388E3C;
    classDef output fill:#FFF9C4,stroke:#FBC02D;
    classDef external fill:#E1BEE7,stroke:#8E24AA;

    click MD "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/draft-ietf-grow-bmp-tcp-ao.md"
    click Makefile "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/tree/main/Makefile"
    click PublishCI "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/.github/workflows/publish.yml"
    click GHPagesCI "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/.github/workflows/ghpages.yml"
    click ArchiveCI "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/.github/workflows/archive.yml"
    click UpdateCI "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/.github/workflows/update.yml"
    click LicenseCI "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/.github/workflows/LICENSE.md"
    click README "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/README.md"
    click CONTRIBUTING "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/CONTRIBUTING.md"
    click LICENSEMeta "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/LICENSE.md"
    click Editorconfig "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/.editorconfig"
    click Gitignore "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/blob/main/.gitignore"
    click Codeowners "https://github.com/hmntsharma/draft-ietf-grow-bmp-tcp-ao/tree/main/.github/CODEOWNERS"
```
