Skip to content

Commit 1e1d98a

Browse files
authored
feature: update readme yaml and rebuild readme md (#51)
1 parent ea8e0bc commit 1e1d98a

File tree

3 files changed

+91
-25
lines changed

3 files changed

+91
-25
lines changed

README.md

Lines changed: 75 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
2+
[![README Header][readme_header_img]][readme_header_link]
23

3-
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
4+
[![Cloud Posse][logo]](https://cpco.io/homepage)
45

56
# terraform-root-modules [![Build Status](https://travis-ci.org/cloudposse/terraform-root-modules.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-root-modules) [![Codefresh Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=terraform-root-modules&branch=master&pipelineName=terraform-root-modules&accountName=cloudposse&type=cf-1)](https://g.codefresh.io/pipelines/terraform-root-modules/builds) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-root-modules.svg)](https://github.com/cloudposse/terraform-root-modules/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
67

@@ -12,7 +13,15 @@ Terraform defines a "root module" as the current working directory holding the T
1213

1314
---
1415

15-
This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps.
16+
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
17+
[<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]
18+
[<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]
19+
[<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]
20+
[<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]
21+
[<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]
22+
[<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]
23+
24+
1625

1726

1827
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -26,6 +35,9 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
2635

2736

2837

38+
39+
40+
2941
## Usage
3042

3143
Use the `terraform-root-modules` Docker image as the base image in the application `Dockerfile`, and copy the modules from `/aws` folder into `/conf` folder.
@@ -54,14 +66,22 @@ For example usage, refer to the "Related Projects" section. This is were we use
5466
```
5567
Available targets:
5668
57-
help This help screen
69+
help Help screen
5870
help/all Display help for all targets
71+
help/short This help short screen
5972
6073
```
6174

6275

6376

6477

78+
## Share the Love
79+
80+
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-root-modules)! (it helps us **a lot**)
81+
82+
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
83+
84+
6585
## Related Projects
6686

6787
Check out these related projects.
@@ -87,26 +107,34 @@ For additional context, refer to some of these links.
87107

88108
File a GitHub [issue](https://github.com/cloudposse/terraform-root-modules/issues), send us an [email][email] or join our [Slack Community][slack].
89109

110+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
111+
90112
## Commercial Support
91113

92114
Work directly with our team of DevOps experts via email, slack, and video conferencing.
93115

94116
We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
95117

96-
[![E-Mail](https://img.shields.io/badge/[email protected])](mailto:[email protected])
118+
[![E-Mail](https://img.shields.io/badge/[email protected])][email]
97119

98120
- **Questions.** We'll use a Shared Slack channel between your team and ours.
99121
- **Troubleshooting.** We'll help you triage why things aren't working.
100122
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
101123
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
102-
- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure.
124+
- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure.
103125
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
104126
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
105127

106128

107-
## Community Forum
108129

109-
Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join 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 *sweet* infrastructure.
130+
131+
## Slack Community
132+
133+
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.
134+
135+
## Newsletter
136+
137+
Signup 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.
110138

111139
## Contributing
112140

@@ -116,7 +144,7 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-root-modu
116144

117145
### Developing
118146

119-
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
147+
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].
120148

121149
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
122150

@@ -131,7 +159,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
131159

132160
## Copyright
133161

134-
Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
162+
Copyright © 2017-2018 [Cloud Posse, LLC](https://cpco.io/copyright)
135163

136164

137165

@@ -172,26 +200,16 @@ All other trademarks referenced herein are the property of their respective owne
172200

173201
## About
174202

175-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <[email protected]>
203+
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
176204

177-
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
205+
[![Cloud Posse][logo]][website]
178206

179-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
207+
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
180208

181-
We offer paid support on all of our projects.
209+
We offer [paid support][commercial_support] on all of our projects.
182210

183-
Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
211+
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.
184212

185-
[docs]: https://docs.cloudposse.com/
186-
[website]: https://cloudposse.com/
187-
[github]: https://github.com/cloudposse/
188-
[commercial_support]: https://github.com/orgs/cloudposse/projects
189-
[jobs]: https://cloudposse.com/jobs/
190-
[hire]: https://cloudposse.com/contact/
191-
[slack]: https://slack.cloudposse.com/
192-
[linkedin]: https://www.linkedin.com/company/cloudposse
193-
[twitter]: https://twitter.com/cloudposse/
194-
[email]: mailto:[email protected]
195213

196214

197215
### Contributors
@@ -207,3 +225,36 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi
207225
[aknysh_avatar]: https://github.com/aknysh.png?size=150
208226

209227

228+
229+
[![README Footer][readme_footer_img]][readme_footer_link]
230+
[![Beacon][beacon]][website]
231+
232+
[logo]: https://cloudposse.com/logo-300x69.svg
233+
[docs]: https://cpco.io/docs
234+
[website]: https://cpco.io/homepage
235+
[github]: https://cpco.io/github
236+
[jobs]: https://cpco.io/jobs
237+
[hire]: https://cpco.io/hire
238+
[slack]: https://cpco.io/slack
239+
[linkedin]: https://cpco.io/linkedin
240+
[twitter]: https://cpco.io/twitter
241+
[testimonial]: https://cpco.io/leave-testimonial
242+
[newsletter]: https://cpco.io/newsletter
243+
[email]: https://cpco.io/email
244+
[commercial_support]: https://cpco.io/commercial-support
245+
[we_love_open_source]: https://cpco.io/we-love-open-source
246+
[module_development]: https://cpco.io/module-development
247+
[terraform_modules]: https://cpco.io/terraform-modules
248+
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/terraform-root-modules
249+
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/terraform-root-modules
250+
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/terraform-root-modules
251+
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/terraform-root-modules
252+
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/terraform-root-modules
253+
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/terraform-root-modules
254+
[share_twitter]: https://twitter.com/intent/tweet/?text=terraform-root-modules&url=https://github.com/cloudposse/terraform-root-modules
255+
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=terraform-root-modules&url=https://github.com/cloudposse/terraform-root-modules
256+
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/terraform-root-modules
257+
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/terraform-root-modules
258+
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/terraform-root-modules
259+
[share_email]: mailto:?subject=terraform-root-modules&body=https://github.com/cloudposse/terraform-root-modules
260+
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-root-modules?pixel&cs=github&cm=readme&an=terraform-root-modules

README.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@
77
# Name of this project
88
name: "terraform-root-modules"
99

10+
# Tags of this project
11+
tags:
12+
- terraform
13+
- terraform-modules
14+
- aws
15+
- root
16+
- geodesic
17+
- reference-implementation
18+
- reference-architecture
19+
20+
# Categories of this project
21+
categories:
22+
- terraform-modules/root
23+
1024
# Logo for this project
1125
#logo: docs/logo.png
1226

docs/targets.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
```
33
Available targets:
44
5-
help This help screen
5+
help Help screen
66
help/all Display help for all targets
7+
help/short This help short screen
78
89
```

0 commit comments

Comments
 (0)