Skip to content

Commit e3ec3c9

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

File tree

1 file changed

+49
-123
lines changed

1 file changed

+49
-123
lines changed

README.md

+49-123
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
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> [![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)
44
<!-- markdownlint-restore -->
55

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
96

107
<!--
118
@@ -51,32 +48,15 @@ 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+
>
56+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
57+
>
7958
59+
[![README Header][readme_header_img]][readme_header_link]
8060

8161

8262

@@ -232,85 +212,73 @@ The first time you connect, you'll be asked to setup your MFA device. Subsequent
232212

233213

234214

215+
## ✨ Contributing
235216

236-
## Help
237-
238-
**Got a question?** We got answers.
239-
240-
File a GitHub [issue](https://github.com/cloudposse/bastion/issues), send us an [email][email] or join our [Slack Community][slack].
217+
This project is under active development, and we encourage contributions from our community.
218+
Many thanks to our outstanding contributors:
241219

242-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
220+
<a href="https://github.com/cloudposse/bastion/graphs/contributors">
221+
<img src="https://contrib.rocks/image?repo=cloudposse/bastion&max=24" />
222+
</a>
243223

244-
## DevOps Accelerator for Startups
224+
### 🐛 Bug Reports & Feature Requests
245225

226+
Please use the [issue tracker](https://github.com/cloudposse/bastion/issues) to report any bugs or file feature requests.
246227

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+
### 💻 Developing
248229

249-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
230+
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].
250231

251-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
232+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
252233

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.
234+
1. **Fork** the repo on GitHub
235+
2. **Clone** the project to your own machine
236+
3. **Commit** changes to your own branch
237+
4. **Push** your work back up to your fork
238+
5. Submit a **Pull Request** so that we can review your changes
254239

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.
240+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
265241

266-
## Slack Community
242+
### 🌎 Slack Community
267243

268244
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.
269245

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
246+
### 📰 Newsletter
275247

276248
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.
277249

278-
## Office Hours
250+
### 📆 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" />
279251

280252
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
281253

282-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
283-
284-
## Contributing
285-
286-
### Bug Reports & Feature Requests
287-
288-
Please use the [issue tracker](https://github.com/cloudposse/bastion/issues) to report any bugs or file feature requests.
289-
290-
### Developing
254+
## About
291255

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].
293-
294-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
295-
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!
256+
This project is maintained and funded by [Cloud Posse, LLC][website].
257+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
303258

259+
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.
304260

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

307-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
263+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
308264

265+
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.
309266

267+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
268+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
269+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
270+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
271+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
272+
- **Training.** You'll receive hands-on training so your team can operate what we build.
273+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
274+
- **Troubleshooting.** You'll get help to triage when things aren't working.
275+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
276+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
310277

278+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
311279
## License
312280

313-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
281+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
314282

315283
See [LICENSE](LICENSE) for full details.
316284

@@ -333,44 +301,11 @@ specific language governing permissions and limitations
333301
under the License.
334302
```
335303

336-
337-
338-
339-
340-
341-
342-
343-
344304
## Trademarks
345305

346306
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-
307+
---
308+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
374309
[![README Footer][readme_footer_img]][readme_footer_link]
375310
[![Beacon][beacon]][website]
376311
<!-- markdownlint-disable -->
@@ -381,12 +316,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
381316
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=jobs
382317
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=hire
383318
[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
385319
[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
387320
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=office_hours
388321
[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
390322
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=email
391323
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=commercial_support
392324
[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 +329,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
397329
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=readme_footer_link
398330
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
399331
[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
406332
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/bastion?pixel&cs=github&cm=readme&an=bastion
407333
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)