Document Architectural Decisions with ADRs

[timshoaf]

New to project, so feel free to ignore, but the following is my proposition seeing little in the way of documentation and some sort of 'in-progress' architecture around build, CI / CD, etc.

Proposal:

• Utilize Architectural Decision Records to manage the lifecycle of all architecturally significant decisions. Read more here: https://adr.github.io/
• Utilize adr-tools package ( https://github.com/npryce/adr-tools ) to manage the decisions.
• Utilize PR process to handle team approval.

Initial Scope:
Two initial decisions come to mind when looking over this project that will likely bear some discussion.

1. The decision of what the Deployment architecture should look like (static file hosting, proxy?, API server, load balancing, Kubernetes vs Docker Swarm, etc.)

2. What CI / CD to use to assist in unifying Development and Deployment in the Build, Test, and Release cycle.

[omegabytes]

Thanks for writing this up @timshoaf, sorry for the delay in getting back to you.

I like where you're going with ADRs. New concept to me, I'll see if I can make sense of it short term. If you have any good, concise examples of its use, I'd love to see it.

I think over the course of the past two weeks, we've answered question 1 in person. It's probably a good idea to document and link that discussion here for non-local users. We can discuss in the near future.

For 2, my immediate goal is to simply get a simple deployment on a single EC2 instance, using whatever method is the most straight-forward. I am familiar with Travis and CodePipeline, but have no preference. We've briefly discussed CircleCI, so that works for me!

Regardless of my stated goal, the advanced development and deployment process with some tooling we spoke about last Weds is awesome and you should pursue it. A few members of the team reviewed and gave me glowing feedback.

Thanks for bringing this level of attention and detail. The lack of direction on my part has the website struggling a bit, so I appreciate your time getting this together!