Update docs in README.md + CoC

Author: meatballhat

CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at
+[email protected]. All complaints will be reviewed and
+investigated and will result in a response that is deemed necessary and
+appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident.  Further details of
+specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

LICENSE.md renamed to LICENSE

@@ -1,28 +1,27 @@
 # terraform-config
 
-This repository will contain all of our terraform configs as a monolithic repo.
+This contains all of the Terraform bits for hosted Travis CI :cloud:.
 
 This is what allows us to manage our cloud environments from a central place,
 and change them over time. It should be possible to bring up (or re-create) a
-complete environment with the push of a button.
+complete environment with a few `make` tasks.
 
 ## Status
 
-In production, with mixed adoption across infrastructures.
+In production.  Patches welcome.  Please review the [code of
+conduct](./CODE_OF_CONDUCT.md).
 
 ## Infrastructure
 
-Terraform manages pretty much everything that is not running on Heroku. We build
-images using Packer and then spin up instances in our cloud environments based
-on those images.
-
-We use terraform to manage our main cloud environments as well as some other
-services:
+Terraform manages pretty much everything that is not running on Heroku, and even
+a little bit of some of what is running on Heroku.  We use terraform to manage
+our main cloud environments as well as some other services:
 
 * Amazon Web Services
 * Google Cloud Platform
 * Macstadium
-* (Hopefully more soon)
+* OpenStack
+* Packet
 
 ## Requirements
 
@@ -36,37 +35,35 @@ services:
 ## Set-up
 
 * Clone this repo
-* Clone the keychain repositories
-* Make sure trvs is installed and added to your $PATH. (You can try
-running `trvs generate-config -H travis-scheduler-prod` to check)
-* Set all required environment variables (see the list below). This
-can be achieved by either:
-	* Manually sourcing an .env file (like .example.env)
+* Make sure `trvs` is installed and added to your `$PATH`. (You can try running
+  `trvs generate-config -H travis-scheduler-prod` to check)
+* Set all required environment variables (see the list below). This can achieved
+  by doing something like:
+	* Manually sourcing an `.env` file (like `.example.env`)
 	* Using [autoenv](https://github.com/kennethreitz/autoenv)
-	* Fetching them from your own pass vault
+	* Fetching values from your own pass vault
 
 #### Required environment variables
 
-* TRAVIS_KEYCHAIN_DIR  - should to  be the parent directory of your keychain
-repos
-* GITHUB_TOKEN
-* GITHUB_USERNAME
-* AWS_ACCESS_KEY
-* AWS_SECRET_KEY
-* AWS_REGION
-* HEROKU_API_KEY
-* TF_VAR_ssh_user
-* SLACK_WEBHOOK (can be retrieved via `trvs generate-config -n -f env terraform-config -p '' terraform_common`)
+* `AWS_ACCESS_KEY`
+* `AWS_REGION`
+* `AWS_SECRET_KEY`
+* `GITHUB_TOKEN`
+* `GITHUB_USERNAME`
+* `HEROKU_API_KEY`
+* `SLACK_WEBHOOK` (may be retrieved via `trvs generate-config -n -f env terraform-config -p '' terraform_common`)
+* `TF_VAR_ssh_user`
+* `TRAVIS_KEYCHAIN_DIR` - should be the parent directory of your keychain repos
 
 #### Notes
 
 MacStadium & GCE access creds are shared and come from keychain, not
 personal accounts, so there are no infrastructure-specific access keys
 for them.
 
-$TF_VAR_ssh_user isn't needed for AWS and can just be set to $USER, if
-your local username and your SSH username are the same. If you have an
-SSH key passphrase, consider starting `ssh-agent` and doing `ssh-add`.
+`$TF_VAR_ssh_user` isn't needed for AWS and can just be set to `$USER`, if your
+local username and your SSH username are the same. If you have an SSH key
+passphrase, consider starting `ssh-agent` and doing `ssh-add`.
 
 See http://rabexc.org/posts/using-ssh-agent for more details.
 
@@ -79,17 +76,20 @@ cd ./gce-staging-1
 
 # terraform plan, which will automatically configure terraform from remote and
 # generate config files via `trvs`
-make clean plan
+make plan
 
 # if it looks OK, terraform apply
 make apply
-```
 
+# as some configuration is generated and cached locally, changes to
+# configuration sources may require cleaning before further plan/apply
+make clean
+```
 
 ## Troubleshooting tips
 
 * Running `make check` will verify a few common setup requirements.
-* Verify you have been added to both com and pro Heroku organizations.
+* Verify you have been added to the relevant Heroku organizations.
 * Try passing the `-d` flag to `make` to see which commands are being
 run.
 	* this will show various curl commands (e.g. heroku) which may be
@@ -100,3 +100,7 @@ run.
 * Terraform state errors may be due to insufficient AWS permissions.  See the
   [`.example-aws-iam-policy.json`](./.example-aws-iam-policy.json) for example
 minimum permissions.
+
+## License
+
+See [`./LICENSE`](./LICENSE).