Recommendation: Explain what the repo contains, how it works, and why in the readme
wparad opened this issue · comments
Right now the readme is a list of files and a motivation, but it doesn't really talk about at all what is in this repo or what problem it solves. Some friendly advice, that you can of course choose to completely ignore.
I would expect in big words at the top of the readme:
Terraform-User-Management Template
This repo is a template that automatically maintains your employees access to the following services:
- Google Workspace
- GitHub
- AWS
Runbooks:
- When onboarding a new engineer is added to your team....
- When offboarding an engineer...
How do you use this repo
- Fork it
- Setup your github actions
- configure XYZ in your google workspace account, your github org, and your AWS account
- etc...
- Profit
How this repository works
...
Here are the important directory files
Motivations
Put the motivations all the way at the bottom here.