j40-cejst-2/docs/architecture/README.md

# Architecture

The below is a general architecture of our proposed system:

![Architecture](architecture-mmd.svg)

The following is a more detailed diagram of the data pipeline architecture utilizing S3 buckets for file/data hosting on Geoplatform.gov.

![Geo Data Pipeline](geodata-pipeline-arch-mmd.svg)

## Updating the Diagram

**Note: Do Not directly modify the svg file, it is generated automatically!**

In the event that you are interested in updating the architecture of our system, please go through the Architecture Decision Record Process (see [here](https://github.com/usds/justice40-tool/tree/main/docs/decisions) for more detail on this process).

Provided you have already done this, however, and/or would like to make small changes to the diagram itself, please read on!

This diagram was generated from a text-based markdown-like file using [MermaidJS](https://mermaid-js.github.io/) syntax and the [Compile Mermaid Markdown](https://github.com/neenjaw/compile-mermaid-markdown-action) Github Action.

To update, consult Mermaid syntax [here](https://mermaid-js.github.io/mermaid/#/flowchart) and update the `architecture.mmd` file.

To preview your changes, see Use Cases and Integrations [here](https://mermaid-js.github.io/mermaid/#/integrations) in order to setup editor integration.

Once you are satisfied with your change, create a pull request. The `compile_mermaid.yml` workflow ([here](https://github.com/usds/justice40-tool/blob/main/.github/workflows/compile_mermaid.yml)) will automatically generate and commit an SVG version of your diagram with the name `X.svg`.
Architecture Diagram and Process (#33) * Use compile mermaid extension * initial Mermaid arch diagram * updating mmd extension * small mmd update * Adding git add step * Expanding acronym * adding branch spec * Add changes * outputting SVG instead as PNG is too small * Add changes * updating readme * Backlog->Roadmap * Add changes * Updating casing for consistency * Updating documentation to specify 'update' section applies just to diagram Co-authored-by: GitHub Action <action@github.com> 2021-05-10 16:15:42 -04:00			`# Architecture`

			`The below is a general architecture of our proposed system:`

			`![Architecture](architecture-mmd.svg)`

Update diagrams in architecture docs (#790) * Update diagrams in architecture docs * Updates overall diagram to represent current arch and process (including vision for data selection) * Updates geo data pipleline arch diagram and removes geoplatform version since we only have one version of this for the foreseeable future and we're using geoplatform infradstructure * Update diagram to remove something we do not yet do * Updating Diagram Co-authored-by: Shelby Switzer <shelby.switzer@cms.hhs.gov> Co-authored-by: GitHub Action <action@github.com> 2021-10-08 13:12:03 -04:00			`The following is a more detailed diagram of the data pipeline architecture utilizing S3 buckets for file/data hosting on Geoplatform.gov.`
Add diagrams detailing our geo data pipeline (#170) * Detailed flow for data inputs, census data, score creation, and geo data generation (geoJSON and MVT) * Include diagram showing vision for geoplatform ownership Co-authored-by: Shelby Switzer <shelby.switzer@cms.hhs.gov> 2021-06-18 10:21:23 -04:00
			`![Geo Data Pipeline](geodata-pipeline-arch-mmd.svg)`

Architecture Diagram and Process (#33) * Use compile mermaid extension * initial Mermaid arch diagram * updating mmd extension * small mmd update * Adding git add step * Expanding acronym * adding branch spec * Add changes * outputting SVG instead as PNG is too small * Add changes * updating readme * Backlog->Roadmap * Add changes * Updating casing for consistency * Updating documentation to specify 'update' section applies just to diagram Co-authored-by: GitHub Action <action@github.com> 2021-05-10 16:15:42 -04:00			`## Updating the Diagram`

			`Note: Do Not directly modify the svg file, it is generated automatically!`

			`In the event that you are interested in updating the architecture of our system, please go through the Architecture Decision Record Process (see [here](https://github.com/usds/justice40-tool/tree/main/docs/decisions) for more detail on this process).`

			`Provided you have already done this, however, and/or would like to make small changes to the diagram itself, please read on!`

Fix broken YML links and add PR template (#1340) * Fix MD files with broken links - fixing all broken links - all YML files are now in capital case * Add PR template * remove comments 2022-02-25 14:39:38 -05:00			`This diagram was generated from a text-based markdown-like file using [MermaidJS](https://mermaid-js.github.io/) syntax and the [Compile Mermaid Markdown](https://github.com/neenjaw/compile-mermaid-markdown-action) Github Action.`
Architecture Diagram and Process (#33) * Use compile mermaid extension * initial Mermaid arch diagram * updating mmd extension * small mmd update * Adding git add step * Expanding acronym * adding branch spec * Add changes * outputting SVG instead as PNG is too small * Add changes * updating readme * Backlog->Roadmap * Add changes * Updating casing for consistency * Updating documentation to specify 'update' section applies just to diagram Co-authored-by: GitHub Action <action@github.com> 2021-05-10 16:15:42 -04:00
			To update, consult Mermaid syntax [here](https://mermaid-js.github.io/mermaid/#/flowchart) and update the `architecture.mmd` file.

			`To preview your changes, see Use Cases and Integrations [here](https://mermaid-js.github.io/mermaid/#/integrations) in order to setup editor integration.`

			Once you are satisfied with your change, create a pull request. The `compile_mermaid.yml` workflow ([here](https://github.com/usds/justice40-tool/blob/main/.github/workflows/compile_mermaid.yml)) will automatically generate and commit an SVG version of your diagram with the name `X.svg`.