From 8428997ad013681cf51358da4a0ca2c29fec8fba Mon Sep 17 00:00:00 2001 From: Erik Osterman Date: Tue, 16 Jan 2024 15:22:05 -0600 Subject: [PATCH] Update README --- README.md | 161 +++++++++++++--------------------------------- README.yaml | 1 - docs/terraform.md | 24 +++++++ 3 files changed, 67 insertions(+), 119 deletions(-) diff --git a/README.md b/README.md index 4795f5ab..7e30e573 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ -# .github [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) +# .github [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) -[![README Header][readme_header_img]][readme_header_link] - -[![Cloud Posse][logo]](https://cpco.io/homepage) -## .github This repository fulfills several unique functions functions for Cloud Posse. 1. It can contain special org-level files that provide functionality for our organization on GitHub. These files include: - `profile/README.md` @@ -46,21 +42,15 @@ This repository fulfills several unique functions functions for Cloud Posse. - `renovate.json` - `.github/workflows/*` ---- - -This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps. -[][share_email] -[][share_googleplus] -[][share_facebook] -[][share_reddit] -[][share_linkedin] -[][share_twitter] - - +--- +> [!NOTE] +> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps. +> +> It's 100% Open Source and licensed under the [APACHE2](LICENSE). +> -It's 100% Open Source and licensed under the [APACHE2](LICENSE). - +[![README Header][readme_header_img]][readme_header_link] @@ -69,38 +59,59 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE). +## Examples +To add all repository bootstrapping files to a new repo: + 1. Copy the `.github/workflows/auto-format.yml` file from this repository to the `.github/workflows` folder of the destination repository. + 2. Execute the `Auto-format` GitHub Action in the destination repository. +## ✨ Contributing +This project is under active development, and we encourage contributions from our community. +Many thanks to our outstanding contributors: + + + +### 🐛 Bug Reports & Feature Requests +Please use the [issue tracker](https://github.com/cloudposse/.github/issues) to report any bugs or file feature requests. -## Examples +### 💻 Developing -To add all repository bootstrapping files to a new repo: - 1. Copy the `.github/workflows/auto-format.yml` file from this repository to the `.github/workflows` folder of the destination repository. - 2. Execute the `Auto-format` GitHub Action in the destination repository. +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]. +In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. + 1. **Fork** the repo on GitHub + 2. **Clone** the project to your own machine + 3. **Commit** changes to your own branch + 4. **Push** your work back up to your fork + 5. Submit a **Pull Request** so that we can review your changes +**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! +### 🌎 Slack Community +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. -## Help +### 📰 Newsletter -**Got a question?** We got answers. +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. -File a GitHub [issue](https://github.com/cloudposse/.github/issues), send us an [email][email] or join our [Slack Community][slack]. +### 📆 Office Hours -[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link] +[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone! -## DevOps Accelerator for Startups +## About +This project is maintained and funded by [Cloud Posse, LLC][website]. + 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. @@ -121,54 +132,7 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our - **Code Reviews.** You'll receive constructive feedback on Pull Requests. - **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects. -## Slack Community - -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. - -## Discourse Forums - -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. - -## Newsletter - -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. - -## Office Hours - -[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone! - -[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours] - -## Contributing - -### Bug Reports & Feature Requests - -Please use the [issue tracker](https://github.com/cloudposse/.github/issues) to report any bugs or file feature requests. - -### Developing - -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]. - -In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. - - 1. **Fork** the repo on GitHub - 2. **Clone** the project to your own machine - 3. **Commit** changes to your own branch - 4. **Push** your work back up to your fork - 5. Submit a **Pull Request** so that we can review your changes - -**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! - - - -## Copyrights - -Copyright © 2022-2022 [Cloud Posse, LLC](https://cloudposse.com) - - - - - +[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link] ## License [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) @@ -194,47 +158,16 @@ specific language governing permissions and limitations under the License. ``` - - - - - - - - ## Trademarks All other trademarks referenced herein are the property of their respective owners. +## Copyrights -## About - -This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]! - -[![Cloud Posse][logo]][website] - -We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source]. - -We offer [paid support][commercial_support] on all of our projects. - -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. - - - -### Contributors - - -| [![Marcin Brański][3h4x_avatar]][3h4x_homepage]
[Marcin Brański][3h4x_homepage] | [![Dylan Bannon][dylanbannon_avatar]][dylanbannon_homepage]
[Dylan Bannon][dylanbannon_homepage] | -|---|---| - - - [3h4x_homepage]: https://github.com/3h4x - [3h4x_avatar]: https://img.cloudposse.com/150x150/https://github.com/3h4x.png - [dylanbannon_homepage]: https://github.com/dylanbannon - [dylanbannon_avatar]: https://img.cloudposse.com/150x150/https://github.com/dylanbannon.png +Copyright © 2022-2024 [Cloud Posse, LLC](https://cloudposse.com) [![README Footer][readme_footer_img]][readme_footer_link] [![Beacon][beacon]][website] - + [logo]: https://cloudposse.com/logo-300x69.svg [docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=docs [website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=website @@ -242,12 +175,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply [jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=jobs [hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=hire [slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=slack - [linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=linkedin [twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=twitter - [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=testimonial [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=office_hours [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=newsletter - [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=discourse [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=email [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=commercial_support [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=we_love_open_source @@ -258,10 +188,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply [readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=readme_footer_link [readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img [readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=readme_commercial_support_link - [share_twitter]: https://twitter.com/intent/tweet/?text=.github&url=https://github.com/cloudposse/.github - [share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=.github&url=https://github.com/cloudposse/.github - [share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/.github - [share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/.github - [share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/.github - [share_email]: mailto:?subject=.github&body=https://github.com/cloudposse/.github [beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/.github?pixel&cs=github&cm=readme&an=.github + diff --git a/README.yaml b/README.yaml index 66d943ba..7b96401c 100644 --- a/README.yaml +++ b/README.yaml @@ -27,7 +27,6 @@ badges: # Short description of this project description: |- - ## .github This repository fulfills several unique functions functions for Cloud Posse. 1. It can contain special org-level files that provide functionality for our organization on GitHub. These files include: - `profile/README.md` diff --git a/docs/terraform.md b/docs/terraform.md index 8b137891..128ef8b4 100644 --- a/docs/terraform.md +++ b/docs/terraform.md @@ -1 +1,25 @@ + +## Requirements +No requirements. + +## Providers + +No providers. + +## Modules + +No modules. + +## Resources + +No resources. + +## Inputs + +No inputs. + +## Outputs + +No outputs. +