refactoring readme and creating dev documentation

jduss4 commented 3 weeks ago

Changes proposed in this pull request:

streamlines the readme to make initial setup less confusing
moves several sections into dev-practices to reduce clutter in main readme
adds documentation about manually deploying
updates the example config files

Related issues

None

Submitter checklist

[ ] Added logging is not capturing sensitive data and is set to an appropriate level (DEBUG vs INFO etc)
[X] Updated relevant documentation (README, ADRs, explainers, diagrams)

Security considerations

I added the dev URL into the documentation, as the cloud team told me that it was not sensitive. This should make it easier for new folks to follow the instructions without having to ask for help from another team member.

echappen commented 3 weeks ago

The new README follows a very natural progression to me—great work! I'm too familiar with the material to be the best judge of how helpful this is, so I'll leave it to @cannandev or @beepdotgov to give the final approval.

beepdotgov commented 3 weeks ago

I also think it’s fantastic! Seriously, this is structured really nicely, and it’s so easy to follow. Thanks so much for pulling all of this together.

The Committing section made me think: is it worth mentioning the need for gpg-signed commits somewhere here? (I tripped over that recently, which is why it’s coming to mind.)

That’s literally all I’ve got. Nice work!

cloud-gov / cg-ui