Skip to content

Commit ad7c0f8

Browse files
authored
Update README.md and docs
1 parent 6dd7fae commit ad7c0f8

File tree

1 file changed

+45
-40
lines changed

1 file changed

+45
-40
lines changed

README.md

Lines changed: 45 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11

22
<!-- markdownlint-disable -->
3-
# github-action-atmos-terraform-plan [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg)](https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# github-action-atmos-terraform-plan <a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
4+
<a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
45
<!-- markdownlint-restore -->
56

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9-
107
<!--
118
129
1310
1411
1512
** DO NOT EDIT THIS FILE
1613
**
17-
** This file was automatically generated by the `build-harness`.
14+
** This file was automatically generated by the `cloudposse/build-harness`.
1815
** 1) Make all changes to `README.yaml`
1916
** 2) Run `make init` (you only need to do this once)
2017
** 3) Run`make readme` to rebuild this file.
@@ -30,22 +27,17 @@
3027

3128
This Github Action is used to run Terraform plan for a single, Atmos-supported component and save the given planfile to S3 and DynamoDB.
3229

33-
---
34-
35-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
36-
37-
38-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
39-
40-
41-
42-
43-
44-
45-
46-
4730

31+
---
32+
> [!NOTE]
33+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
34+
> <details><summary>Learn More</summary>
35+
>
36+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
37+
>
38+
> </details>
4839
40+
[![README Header][readme_header_img]][readme_header_link]
4941

5042

5143
## Introduction
@@ -226,7 +218,7 @@ For additional context, refer to some of these links.
226218

227219
## ✨ Contributing
228220

229-
This project is under active development, and we encourage contributions from our community.
221+
This project is under active development, and we encourage contributions from our community.
230222
Many thanks to our outstanding contributors:
231223

232224
<a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/graphs/contributors">
@@ -239,15 +231,16 @@ Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos
239231

240232
### 💻 Developing
241233

242-
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
234+
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
235+
Hit us up in [Slack][slack], in the `#cloudposse` channel.
243236

244237
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
245-
246-
1. **Fork** the repo on GitHub
247-
2. **Clone** the project to your own machine
248-
3. **Commit** changes to your own branch
249-
4. **Push** your work back up to your fork
250-
5. Submit a **Pull Request** so that we can review your changes
238+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-atmos-terraform-plan/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
239+
2. **Fork** the repo on GitHub
240+
3. **Clone** the project to your own machine
241+
4. **Commit** changes to your own branch
242+
5. **Push** your work back up to your fork
243+
6. Submit a **Pull Request** so that we can review your changes
251244

252245
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
253246

@@ -257,27 +250,34 @@ Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Ou
257250

258251
### 📰 Newsletter
259252

260-
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
253+
Sign up for [our newsletter][newsletter] and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
254+
Dropped straight into your Inbox every week — and usually a 5-minute read.
261255

262256
### 📆 Office Hours <img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" />
263257

264-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
258+
[Join us every Wednesday via Zoom][office_hours] for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
259+
It's **FREE** for everyone!
265260

266-
## About
261+
## About
267262

268-
This project is maintained and funded by [Cloud Posse, LLC][website].
263+
This project is maintained by [Cloud Posse, LLC][website].
269264
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
270265

271-
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
266+
We are a [**DevOps Accelerator**][commercial_support] for funded startups and enterprises.
267+
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
268+
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
272269

273270
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
274271

275-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
272+
*Your team can operate like a pro today.*
276273

277-
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
274+
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
275+
276+
<details>
277+
<summary>📚 <strong>What's included?</strong></summary>
278278

279279
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
280-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
280+
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
281281
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
282282
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
283283
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
@@ -286,14 +286,18 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
286286
- **Troubleshooting.** You'll get help to triage when things aren't working.
287287
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
288288
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
289+
</details>
289290

290291
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
291292
## License
292293

293-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
294-
295-
See [LICENSE](LICENSE) for full details.
294+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
296295

296+
<details>
297+
<summary>Preamble to the Apache License, Version 2.0</summary>
298+
<br/>
299+
<br/>
300+
Complete license is available in the [`LICENSE`](LICENSE) file.
297301
```text
298302
Licensed to the Apache Software Foundation (ASF) under one
299303
or more contributor license agreements. See the NOTICE file
@@ -312,12 +316,13 @@ KIND, either express or implied. See the License for the
312316
specific language governing permissions and limitations
313317
under the License.
314318
```
319+
</details>
315320

316321
## Trademarks
317322

318323
All other trademarks referenced herein are the property of their respective owners.
319324
---
320-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
325+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
321326
[![README Footer][readme_footer_img]][readme_footer_link]
322327
[![Beacon][beacon]][website]
323328
<!-- markdownlint-disable -->

0 commit comments

Comments
 (0)