Skip to content

(maint) link the contributing doc in the readme #561

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 10, 2024
Merged

(maint) link the contributing doc in the readme #561

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions README.md
View file
Open in desktop
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