search

hashicorp-demoapp / infrastructure

Contains infrastructure as code for running demo app locally or in the cloud
Mozilla Public License 2.0
18 stars 8 forks source link

Improve diagram and README.md #3

Open rberlind opened 3 years ago

rberlind commented 3 years ago

The diagram in the README is confusing because of its use of "Graphql API". While that is described in the README.md when people deploy HashiCups, they deploy the frontend app along with the product API, public-api, postgres, and payment services.

I think the diagram and README.md need to change "GRAPHQL API" to "PUBLIC API" or "PUBLIC-API" and need to change "GUI" to "FRONTEND" or "Frontend". These will better correspond to https://github.com/hashicorp-demoapp/public-api and https://github.com/hashicorp-demoapp/frontend.

I realized this while evaluating the image that was copied to https://play.instruqt.com/hashicorp/tracks/vault-managing-secrets-and-moving-to-cloud and had a hard time understanding the diagram.

karl-cardenas-coding commented 3 years ago

@rberlind I agree. I'm also not sure if Reddis is used anymore.

rberlind commented 3 years ago

That would be another issue which I had not even realized. :)