Skip to content

Commit f205b87

Browse files
authored
Update README.md and docs
1 parent 622f819 commit f205b87

File tree

1 file changed

+70
-129
lines changed

1 file changed

+70
-129
lines changed

README.md

+70-129
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11

22
<!-- markdownlint-disable -->
3-
# bastion [![Latest Release](https://img.shields.io/github/release/cloudposse/bastion.svg)](https://github.com/cloudposse/bastion/releases/latest) [![Build & Test Status](https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# bastion <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/bastion/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/bastion.svg" alt="Latest Release"/></a><a href="https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml"><img src="https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml/badge.svg" alt="Build & Test Status"/></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.
@@ -51,32 +48,17 @@ We recommend using Slack notifications for self-reporting.
5148
* A "buddy" should approve the login by adding a reaction (e.g. ✅).
5249
* If no one approves the login, it should trigger an *incident response* to track down the unauthorized access.
5350

54-
---
55-
56-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
57-
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
58-
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
59-
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
60-
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit]
61-
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin]
62-
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter]
63-
64-
65-
66-
67-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
68-
69-
70-
71-
72-
73-
74-
75-
76-
77-
7851

52+
---
53+
> [!NOTE]
54+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
55+
> <details><summary>Learn More</summary>
56+
>
57+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
58+
>
59+
> </details>
7960
61+
[![README Header][readme_header_img]][readme_header_link]
8062

8163

8264

@@ -232,88 +214,88 @@ The first time you connect, you'll be asked to setup your MFA device. Subsequent
232214

233215

234216

217+
## ✨ Contributing
235218

236-
## Help
219+
This project is under active development, and we encourage contributions from our community.
220+
Many thanks to our outstanding contributors:
237221

238-
**Got a question?** We got answers.
222+
<a href="https://github.com/cloudposse/bastion/graphs/contributors">
223+
<img src="https://contrib.rocks/image?repo=cloudposse/bastion&max=24" />
224+
</a>
239225

240-
File a GitHub [issue](https://github.com/cloudposse/bastion/issues), send us an [email][email] or join our [Slack Community][slack].
226+
### 🐛 Bug Reports & Feature Requests
241227

242-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
243-
244-
## DevOps Accelerator for Startups
245-
246-
247-
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.
228+
Please use the [issue tracker](https://github.com/cloudposse/bastion/issues) to report any bugs or file feature requests.
248229

249-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
230+
### 💻 Developing
250231

251-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
232+
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!
233+
Hit us up in [Slack][slack], in the `#cloudposse` channel.
252234

253-
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.
235+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
236+
1. Review our [Code of Conduct](https://github.com/cloudposse/bastion/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
237+
2. **Fork** the repo on GitHub
238+
3. **Clone** the project to your own machine
239+
4. **Commit** changes to your own branch
240+
5. **Push** your work back up to your fork
241+
6. Submit a **Pull Request** so that we can review your changes
254242

255-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
256-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
257-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
258-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
259-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
260-
- **Training.** You'll receive hands-on training so your team can operate what we build.
261-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
262-
- **Troubleshooting.** You'll get help to triage when things aren't working.
263-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
264-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
243+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
265244

266-
## Slack Community
245+
### 🌎 Slack Community
267246

268247
Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
269248

270-
## Discourse Forums
271-
272-
Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
273-
274-
## Newsletter
275-
276-
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.
277-
278-
## Office Hours
279-
280-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
249+
### 📰 Newsletter
281250

282-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
251+
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.
252+
Dropped straight into your Inbox every week — and usually a 5-minute read.
283253

284-
## Contributing
254+
### 📆 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" />
285255

286-
### Bug Reports & Feature Requests
256+
[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.
257+
It's **FREE** for everyone!
287258

288-
Please use the [issue tracker](https://github.com/cloudposse/bastion/issues) to report any bugs or file feature requests.
289-
290-
### Developing
291-
292-
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].
259+
## About
293260

294-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
261+
This project is maintained by [Cloud Posse, LLC][website].
262+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
295263

296-
1. **Fork** the repo on GitHub
297-
2. **Clone** the project to your own machine
298-
3. **Commit** changes to your own branch
299-
4. **Push** your work back up to your fork
300-
5. Submit a **Pull Request** so that we can review your changes
301-
302-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
264+
We are a [**DevOps Accelerator**][commercial_support] for funded startups and enterprises.
265+
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
266+
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
303267

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

305-
## Copyright
270+
*Your team can operate like a pro today.*
306271

307-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
272+
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
308273

274+
<details>
275+
<summary>📚 <strong>What's included?</strong></summary>
309276

277+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
278+
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
279+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
280+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
281+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
282+
- **Training.** You'll receive hands-on training so your team can operate what we build.
283+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
284+
- **Troubleshooting.** You'll get help to triage when things aren't working.
285+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
286+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
287+
</details>
310288

289+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
311290
## License
312291

313-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
314-
315-
See [LICENSE](LICENSE) for full details.
292+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
316293

294+
<details>
295+
<summary>Preamble to the Apache License, Version 2.0</summary>
296+
<br/>
297+
<br/>
298+
Complete license is available in the [`LICENSE`](LICENSE) file.
317299
```text
318300
Licensed to the Apache Software Foundation (ASF) under one
319301
or more contributor license agreements. See the NOTICE file
@@ -332,45 +314,13 @@ KIND, either express or implied. See the License for the
332314
specific language governing permissions and limitations
333315
under the License.
334316
```
335-
336-
337-
338-
339-
340-
341-
342-
317+
</details>
343318

344319
## Trademarks
345320

346321
All other trademarks referenced herein are the property of their respective owners.
347-
348-
## About
349-
350-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
351-
352-
[![Cloud Posse][logo]][website]
353-
354-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
355-
356-
We offer [paid support][commercial_support] on all of our projects.
357-
358-
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
359-
360-
361-
362-
### Contributors
363-
364-
<!-- markdownlint-disable -->
365-
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Marji Cermak][marji_avatar]][marji_homepage]<br/>[Marji Cermak][marji_homepage] |
366-
|---|---|
367-
<!-- markdownlint-restore -->
368-
369-
[osterman_homepage]: https://github.com/osterman
370-
[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png
371-
[marji_homepage]: https://github.com/marji
372-
[marji_avatar]: https://img.cloudposse.com/150x150/https://github.com/marji.png
373-
322+
---
323+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
374324
[![README Footer][readme_footer_img]][readme_footer_link]
375325
[![Beacon][beacon]][website]
376326
<!-- markdownlint-disable -->
@@ -381,12 +331,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
381331
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=jobs
382332
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=hire
383333
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=slack
384-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=linkedin
385334
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=twitter
386-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=testimonial
387335
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=office_hours
388336
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=newsletter
389-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=discourse
390337
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=email
391338
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=commercial_support
392339
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=we_love_open_source
@@ -397,11 +344,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
397344
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=readme_footer_link
398345
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
399346
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=readme_commercial_support_link
400-
[share_twitter]: https://twitter.com/intent/tweet/?text=bastion&url=https://github.com/cloudposse/bastion
401-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=bastion&url=https://github.com/cloudposse/bastion
402-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/bastion
403-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/bastion
404-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/bastion
405-
[share_email]: mailto:?subject=bastion&body=https://github.com/cloudposse/bastion
406347
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/bastion?pixel&cs=github&cm=readme&an=bastion
407348
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)