j40-cejst-2/docs/architecture
Shelby Switzer 1f78920f63
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
..
architecture-mmd.svg Update diagrams in architecture docs (#790) 2021-10-08 13:12:03 -04:00
architecture.mmd Update diagrams in architecture docs (#790) 2021-10-08 13:12:03 -04:00
geodata-pipeline-arch-mmd.svg Update diagrams in architecture docs (#790) 2021-10-08 13:12:03 -04:00
geodata-pipeline-arch.mmd Update diagrams in architecture docs (#790) 2021-10-08 13:12:03 -04:00
README.md Update diagrams in architecture docs (#790) 2021-10-08 13:12:03 -04:00

Architecture

The below is a general architecture of our proposed system:

Architecture

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

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 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 syntax and the Compile Mermaid Markdown Github Action.

To update, consult Mermaid syntax here and update the architecture.mmd file.

To preview your changes, see Use Cases and Integrations here in order to setup editor integration.

Once you are satisfied with your change, create a pull request. The compile_mermaid.yml workflow (here) will automatically generate and commit an SVG version of your diagram with the name X.svg.