Skip to content

Commit 4191a20

Browse files
authored
Update README.md and docs
1 parent bbd3e9b commit 4191a20

File tree

1 file changed

+45
-42
lines changed

1 file changed

+45
-42
lines changed

README.md

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

22
<!-- markdownlint-disable -->
3-
# github-action-atmos-terraform-select-components
4-
5-
[![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-select-components.svg)](https://github.com/cloudposse/github-action-atmos-terraform-select-components/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# github-action-atmos-terraform-select-components <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-select-components/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-select-components.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
65
<!-- markdownlint-restore -->
76

8-
[![README Header][readme_header_img]][readme_header_link]
9-
10-
[![Cloud Posse][logo]](https://cpco.io/homepage)
11-
127
<!--
138
149
1510
1611
1712
** DO NOT EDIT THIS FILE
1813
**
19-
** This file was automatically generated by the `build-harness`.
14+
** This file was automatically generated by the `cloudposse/build-harness`.
2015
** 1) Make all changes to `README.yaml`
2116
** 2) Run `make init` (you only need to do this once)
2217
** 3) Run`make readme` to rebuild this file.
@@ -32,22 +27,17 @@
3227

3328
GitHub Action that outputs list of Atmos components by jq query
3429

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

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>
5039
40+
[![README Header][readme_header_img]][readme_header_link]
5141

5242

5343
## Introduction
@@ -198,7 +188,7 @@ For additional context, refer to some of these links.
198188

199189
## ✨ Contributing
200190

201-
This project is under active development, and we encourage contributions from our community.
191+
This project is under active development, and we encourage contributions from our community.
202192
Many thanks to our outstanding contributors:
203193

204194
<a href="https://github.com/cloudposse/github-action-atmos-terraform-select-components/graphs/contributors">
@@ -211,15 +201,16 @@ Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos
211201

212202
### 💻 Developing
213203

214-
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].
204+
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!
205+
Hit us up in [Slack][slack], in the `#cloudposse` channel.
215206

216207
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
217-
218-
1. **Fork** the repo on GitHub
219-
2. **Clone** the project to your own machine
220-
3. **Commit** changes to your own branch
221-
4. **Push** your work back up to your fork
222-
5. Submit a **Pull Request** so that we can review your changes
208+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-atmos-terraform-select-components/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
209+
2. **Fork** the repo on GitHub
210+
3. **Clone** the project to your own machine
211+
4. **Commit** changes to your own branch
212+
5. **Push** your work back up to your fork
213+
6. Submit a **Pull Request** so that we can review your changes
223214

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

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

230221
### 📰 Newsletter
231222

232-
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.
223+
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.
224+
Dropped straight into your Inbox every week — and usually a 5-minute read.
233225

234226
### 📆 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" />
235227

236-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
228+
[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.
229+
It's **FREE** for everyone!
237230

238-
## About
231+
## About
239232

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

243-
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.
236+
We are a [**DevOps Accelerator**][commercial_support] for funded startups and enterprises.
237+
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
238+
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
244239

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

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

249-
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.
244+
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
245+
246+
<details>
247+
<summary>📚 <strong>What's included?</strong></summary>
250248

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

262261
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
263262
## License
264263

265-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
266-
267-
See [LICENSE](LICENSE) for full details.
264+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
268265

266+
<details>
267+
<summary>Preamble to the Apache License, Version 2.0</summary>
268+
<br/>
269+
<br/>
270+
Complete license is available in the [`LICENSE`](LICENSE) file.
269271
```text
270272
Licensed to the Apache Software Foundation (ASF) under one
271273
or more contributor license agreements. See the NOTICE file
@@ -284,12 +286,13 @@ KIND, either express or implied. See the License for the
284286
specific language governing permissions and limitations
285287
under the License.
286288
```
289+
</details>
287290

288291
## Trademarks
289292

290293
All other trademarks referenced herein are the property of their respective owners.
291294
---
292-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
295+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
293296
[![README Footer][readme_footer_img]][readme_footer_link]
294297
[![Beacon][beacon]][website]
295298
<!-- markdownlint-disable -->

0 commit comments

Comments
 (0)