New tech stack documentation

edwinjue commented 1 year ago

Overview

We need a volunteer to go through the steps in the Quick Start and document the process on getting the new tech stack set up so it is easy for new volunteers to set up a local development environment.

The following would be an added bonus to the documentation:

Diagrams
Screenshots
Visuals

Remember your target audience has absolutely no idea what is going on and the goal is to be a simple and direct a possible.

Refer to the System Architecture section of the archived aws CONTRIBUTING.md document for reference

Action Items

[ ] @edwinjue will provide an outline of the NRD System Architecture
[ ] Participants will contribute bullet points/details to each part of the outline (can be completed in Google Drive, but provide a link to it below)
[ ] Finally, add this "new tech stack" documentation to the bottom of CONTRIBUTING.md when it becomes available (need to wait for #1556 to be completed)

Active PR

https://github.com/hackforla/311-data/pull/1610

Resources/Instructions

Refer to the archived aws CONTRIBUTING.md for reference

ryanfchase commented 7 months ago

Moving this to In Review, since there is a PR out for review on this. Clearing assignees unless someone is actively working on this ticket or actively modifying the ticket.

ryanfchase commented 6 months ago

I'm moving this ticket back to New Issue Approval. One PR was completed for this PR, but this issue feels more like an Epic. Which is fine, but it should be organized as such -- and smaller issues should be broken down to provide detailed instruction for devs.

aka the issue is to nebulous, I think a dev or dev lead could break this down into even smaller Good First Issue tickets

hackforla / 311-data