Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(doc): #919 architecture diagram #923

Merged
merged 1 commit into from
Sep 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ SPDX-License-Identifier: MIT
-->

- [Introduction](./README.md)
- [Architecture](./architecture/README.md)
- [Contributing](./contributing/README.md)
- [Governance](./governance/README.md)
- [Security](./security/README.md)
Expand Down
40 changes: 40 additions & 0 deletions docs/src/architecture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
SPDX-FileCopyrightText: 2022 Fluid Attacks and Makes contributors

SPDX-License-Identifier: MIT
-->

# Architecture

```mermaid
flowchart TB
inputs[Other inputs]
makes_cli[Makes CLI]
makes_framework[Makes Framework]
slsa_provenance[SLSA Provenance Attestation]
nix_derivation[Nix Derivation SBOM]
nix_store_path[Nix Store Path - Built artifact]
nixpkgs_collection[Nixpkgs Software Packages]
nixpkgs_module_system[Nixpkgs Module System]
consumer[Consumer]
developer[Developer]
project[Project]
git_repo[Git Repository]
ci_cd_code[CI/CD as code]
inputs[Other inputs]

consumer -- uses --> makes_cli
ci_cd_code -- uses --> nixpkgs_collection
ci_cd_code -- uses --> makes_framework
ci_cd_code -- uses --> inputs
developer -- uses --> makes_cli
developer -- maintains --> project
git_repo -- is fetched by --> makes_cli
git_repo -- contains --> ci_cd_code
makes_cli -- uses --> nix
makes_cli -- produces --> slsa_provenance
makes_framework -- uses --> nixpkgs_module_system
nix -- produces --> nix_derivation
nix -- produces --> nix_store_path
project -- has --> git_repo
```