Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recommendation: Explain what the repo contains, how it works, and why in the readme #3

Open
wparad opened this issue Nov 1, 2023 · 0 comments

Comments

@wparad
Copy link

wparad commented Nov 1, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant