Skip to content

Commit

Permalink
(maint) link the contributing doc in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tphoney committed Sep 10, 2024
1 parent aafa676 commit 15d27ac
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Overmind is a powerful tool for real-time impact analysis on Terraform changes.

Install the Overmind CLI using brew:

```
```shell
brew install overmindtech/overmind/overmind-cli
```

Run a terraform plan:

```
```shell
overmind terraform plan
```

Expand All @@ -48,7 +48,7 @@ overmind terraform plan

To install on Mac with homebrew use:

```
```shell
brew install overmindtech/overmind/overmind-cli
```

Expand Down Expand Up @@ -161,12 +161,13 @@ Additionally a community maintained package can be found in the [aur](https://au

## Why Use Overmind?

* **☁️ Cloud Complexity:** Terraform tells you what it's going to change, but not whether this change will break everything. Teams need to understand dependencies to properly understand impact.
* **👨‍🏫 Onboarding & Productivity:** Due to the reliance on "tribal knowledge", expert staff are stuck doing approvals rather than productive work and newer staff take longer to become productive.
* **📋 Change Management Process:** IaC and automation mean that changes spend substantially more time in review and approval steps than the change itself actually takes.
* **🔥 Downtime:** Outages are not caused by simple cause-and-effect relationships. More often than not, downtime is a result of dependencies people didn't know existed.
- **☁️ Cloud Complexity:** Terraform tells you what it's going to change, but not whether this change will break everything. Teams need to understand dependencies to properly understand impact.
- **👨‍🏫 Onboarding & Productivity:** Due to the reliance on "tribal knowledge", expert staff are stuck doing approvals rather than productive work and newer staff take longer to become productive.
- **📋 Change Management Process:** IaC and automation mean that changes spend substantially more time in review and approval steps than the change itself actually takes.
- **🔥 Downtime:** Outages are not caused by simple cause-and-effect relationships. More often than not, downtime is a result of dependencies people didn't know existed.

## How We Solve It?

<table style="width: 100%; table-layout: fixed;">
<tr>
<td style="width: 50%; vertical-align: top;">
Expand Down Expand Up @@ -213,6 +214,10 @@ overmind terraform plan -- -var-file=production.tfvars -parallelism=20 -auto-app

- Want to report a bug or request a feature? [Open an issue](https://github.com/overmindtech/cli/issues/new)

## Development

Please look in the [CONTRIBUTING.md](https://github.com/overmindtech/cli/blob/main/CONTRIBUTING.md) document.

## License

See the [LICENSE](/LICENSE) file for licensing information.
Expand Down

0 comments on commit 15d27ac

Please sign in to comment.