Skip to content

Commit 11b6aae

Browse files
authored
Update README.md and docs
1 parent 7356b85 commit 11b6aae

File tree

1 file changed

+38
-25
lines changed

1 file changed

+38
-25
lines changed

README.md

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

22
<!-- markdownlint-disable -->
3-
# github-action-deploy-argocd<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/github-action-deploy-argocd.svg)](https://github.com/cloudposse/github-action-deploy-argocd/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# github-action-deploy-argocd <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-deploy-argocd/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-deploy-argocd.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.
@@ -27,19 +27,19 @@
2727

2828
Deploy on Kubernetes with ArgoCD
2929

30+
3031
---
3132
> [!NOTE]
3233
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
34+
> <details><summary>Learn More</summary>
3335
>
3436
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
3537
>
38+
> </details>
3639
3740
[![README Header][readme_header_img]][readme_header_link]
3841

3942

40-
41-
42-
4343
## Introduction
4444

4545
Deploy on Kubernetes with Helm/HelmFile and ArgoCD.
@@ -188,7 +188,7 @@ For additional context, refer to some of these links.
188188

189189
## ✨ Contributing
190190

191-
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.
192192
Many thanks to our outstanding contributors:
193193

194194
<a href="https://github.com/cloudposse/github-action-deploy-argocd/graphs/contributors">
@@ -201,15 +201,16 @@ Please use the [issue tracker](https://github.com/cloudposse/github-action-deplo
201201

202202
### 💻 Developing
203203

204-
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].
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.
205206

206207
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
207-
208-
1. **Fork** the repo on GitHub
209-
2. **Clone** the project to your own machine
210-
3. **Commit** changes to your own branch
211-
4. **Push** your work back up to your fork
212-
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-deploy-argocd/?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
213214

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

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

220221
### 📰 Newsletter
221222

222-
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.
223225

224226
### 📆 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" />
225227

226-
[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!
227230

228-
## About
231+
## About
229232

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

233-
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.
234239

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

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

239-
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>
240248

241249
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
242-
- **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.
243251
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
244252
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
245253
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
@@ -248,14 +256,18 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
248256
- **Troubleshooting.** You'll get help to triage when things aren't working.
249257
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
250258
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
259+
</details>
251260

252261
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
253262
## License
254263

255-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
256-
257-
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)
258265

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.
259271
```text
260272
Licensed to the Apache Software Foundation (ASF) under one
261273
or more contributor license agreements. See the NOTICE file
@@ -274,6 +286,7 @@ KIND, either express or implied. See the License for the
274286
specific language governing permissions and limitations
275287
under the License.
276288
```
289+
</details>
277290

278291
## Trademarks
279292

0 commit comments

Comments
 (0)