Skip to content

Commit 3384be0

Browse files
Update README.md and docs (#152)
Co-authored-by: max-lobur <max-lobur@users.noreply.github.com>
1 parent 5ea10b3 commit 3384be0

File tree

1 file changed

+50
-29
lines changed

1 file changed

+50
-29
lines changed

README.md

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11

22
<!-- markdownlint-disable -->
3-
# terraform-aws-tfstate-backend<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a> [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-tfstate-backend.svg)](https://github.com/cloudposse/terraform-aws-tfstate-backend/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# terraform-aws-tfstate-backend <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/terraform-aws-tfstate-backend/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-tfstate-backend.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-
77
<!--
88
99
1010
1111
1212
** DO NOT EDIT THIS FILE
1313
**
14-
** This file was automatically generated by the `build-harness`.
14+
** This file was automatically generated by the `cloudposse/build-harness`.
1515
** 1) Make all changes to `README.yaml`
1616
** 2) Run `make init` (you only need to do this once)
1717
** 3) Run`make readme` to rebuild this file.
@@ -46,11 +46,20 @@ __NOTE:__ This module cannot be used to apply changes to the `mfa_delete` featur
4646
---
4747
> [!NOTE]
4848
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
49-
> <a href="https://cpco.io/terraform-modules"><img src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right" /></a>
49+
> <details><summary>Learn More</summary>
50+
> <a href="https://cpco.io/terraform-modules">
51+
> <picture>
52+
> <source media="(prefers-color-scheme: dark)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-light.svg">
53+
> <source media="(prefers-color-scheme: light)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-dark.svg">
54+
> <img alt="Terraform Open Source Modules" src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right">
55+
> </picture>
56+
> </a>
57+
>
5058
>
5159
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
5260
>
5361
> We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
62+
> </details>
5463
5564
[![README Header][readme_header_img]][readme_header_link]
5665

@@ -61,12 +70,11 @@ __NOTE:__ This module cannot be used to apply changes to the `mfa_delete` featur
6170

6271

6372

64-
> **Important**
65-
> We do not pin modules to versions in Cloud Posse's examples because of the
66-
> difficulty of keeping the versions in the documentation in sync with the latest released versions.
67-
> We highly recommend that in your code you pin the version to the exact version you are
68-
> using so that your infrastructure remains stable, and update versions in a
69-
> systematic way so that they do not catch you by surprise.
73+
> [!IMPORTANT]
74+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
75+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
76+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
77+
> approach for updating versions to avoid unexpected changes.
7078
7179

7280

@@ -335,7 +343,7 @@ Check out these related projects.
335343

336344
## ✨ Contributing
337345

338-
This project is under active development, and we encourage contributions from our community.
346+
This project is under active development, and we encourage contributions from our community.
339347
Many thanks to our outstanding contributors:
340348

341349
<a href="https://github.com/cloudposse/terraform-aws-tfstate-backend/graphs/contributors">
@@ -348,15 +356,16 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-tfsta
348356

349357
### 💻 Developing
350358

351-
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 Cloud Posse's other projects, we would love to hear from you! Shoot us an [email][email].
359+
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!
360+
Hit us up in [Slack][slack], in the `#cloudposse` channel.
352361

353362
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
354-
355-
1. **Fork** the repo on GitHub
356-
2. **Clone** the project to your own machine
357-
3. **Commit** changes to your own branch
358-
4. **Push** your work back up to your fork
359-
5. Submit a **Pull Request** so that we can review your changes
363+
1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-tfstate-backend/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
364+
2. **Fork** the repo on GitHub
365+
3. **Clone** the project to your own machine
366+
4. **Commit** changes to your own branch
367+
5. **Push** your work back up to your fork
368+
6. Submit a **Pull Request** so that we can review your changes
360369

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

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

367376
### 📰 Newsletter
368377

369-
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.
378+
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.
379+
Dropped straight into your Inbox every week — and usually a 5-minute read.
370380

371381
### 📆 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" />
372382

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

375-
## About
386+
## About
376387

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

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

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

384-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
397+
*Your team can operate like a pro today.*
398+
399+
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
385400

386-
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.
401+
<details>
402+
<summary>📚 <strong>What's included?</strong></summary>
387403

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

399416
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
400417
## License
401418

402-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
403-
404-
See [LICENSE](LICENSE) for full details.
419+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
405420

421+
<details>
422+
<summary>Preamble to the Apache License, Version 2.0</summary>
423+
<br/>
424+
<br/>
425+
Complete license is available in the [`LICENSE`](LICENSE) file.
406426
```text
407427
Licensed to the Apache Software Foundation (ASF) under one
408428
or more contributor license agreements. See the NOTICE file
@@ -421,6 +441,7 @@ KIND, either express or implied. See the License for the
421441
specific language governing permissions and limitations
422442
under the License.
423443
```
444+
</details>
424445

425446
## Trademarks
426447

0 commit comments

Comments
 (0)