Skip to content

Commit 4257315

Browse files
authored
Update readme yaml file (#34)
* doc: update readme yaml file - add tags and categories * feature: update readme yaml and rebuild readme md
1 parent 3e87525 commit 4257315

File tree

3 files changed

+100
-25
lines changed

3 files changed

+100
-25
lines changed

README.md

Lines changed: 83 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-aws-ec2-instance [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-ec2-instance.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-ec2-instance) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance.svg)](https://github.com/cloudposse/terraform-aws-ec2-instance/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
67

@@ -16,7 +17,17 @@ Included features:
1617

1718
---
1819

19-
This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps.
20+
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
21+
[<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]
22+
[<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]
23+
[<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]
24+
[<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]
25+
[<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]
26+
[<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]
27+
28+
29+
[![Terraform Open Source Modules](https://docs.cloudposse.com/images/terraform-open-source-modules.svg)][terraform_modules]
30+
2031

2132

2233
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -27,6 +38,11 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
2738

2839

2940

41+
We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
42+
43+
44+
45+
3046

3147

3248

@@ -80,8 +96,9 @@ module "kafka_instance" {
8096
```
8197
Available targets:
8298
83-
help This help screen
99+
help Help screen
84100
help/all Display help for all targets
101+
help/short This help short screen
85102
lint Lint terraform code
86103
87104
```
@@ -158,6 +175,13 @@ Available targets:
158175

159176

160177

178+
## Share the Love
179+
180+
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-aws-ec2-instance)! (it helps us **a lot**)
181+
182+
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
183+
184+
161185
## Related Projects
162186

163187
Check out these related projects.
@@ -183,26 +207,38 @@ For additional context, refer to some of these links.
183207

184208
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-ec2-instance/issues), send us an [email][email] or join our [Slack Community][slack].
185209

210+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
211+
186212
## Commercial Support
187213

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

190216
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.
191217

192-
[![E-Mail](https://img.shields.io/badge/[email protected])](mailto:[email protected])
218+
[![E-Mail](https://img.shields.io/badge/[email protected])][email]
193219

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

202228

203-
## Community Forum
204229

205-
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.
230+
## Terraform Module Development
231+
232+
Are you interested in custom Terraform module development? Submit your inquiry using [our form][module_development] today and we'll get back to you ASAP.
233+
234+
235+
## Slack Community
236+
237+
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.
238+
239+
## Newsletter
240+
241+
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.
206242

207243
## Contributing
208244

@@ -212,7 +248,7 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-ec2-i
212248

213249
### Developing
214250

215-
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]).
251+
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].
216252

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

@@ -227,7 +263,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
227263

228264
## Copyright
229265

230-
Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
266+
Copyright © 2017-2018 [Cloud Posse, LLC](https://cpco.io/copyright)
231267

232268

233269

@@ -268,26 +304,16 @@ All other trademarks referenced herein are the property of their respective owne
268304

269305
## About
270306

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

273-
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
309+
[![Cloud Posse][logo]][website]
274310

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

277-
We offer paid support on all of our projects.
313+
We offer [paid support][commercial_support] on all of our projects.
278314

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

281-
[docs]: https://docs.cloudposse.com/
282-
[website]: https://cloudposse.com/
283-
[github]: https://github.com/cloudposse/
284-
[commercial_support]: https://github.com/orgs/cloudposse/projects
285-
[jobs]: https://cloudposse.com/jobs/
286-
[hire]: https://cloudposse.com/contact/
287-
[slack]: https://slack.cloudposse.com/
288-
[linkedin]: https://www.linkedin.com/company/cloudposse
289-
[twitter]: https://twitter.com/cloudposse/
290-
[email]: mailto:[email protected]
291317

292318

293319
### Contributors
@@ -313,3 +339,36 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi
313339
[comeanother_avatar]: https://github.com/comeanother.png?size=150
314340

315341

342+
343+
[![README Footer][readme_footer_img]][readme_footer_link]
344+
[![Beacon][beacon]][website]
345+
346+
[logo]: https://cloudposse.com/logo-300x69.svg
347+
[docs]: https://cpco.io/docs
348+
[website]: https://cpco.io/homepage
349+
[github]: https://cpco.io/github
350+
[jobs]: https://cpco.io/jobs
351+
[hire]: https://cpco.io/hire
352+
[slack]: https://cpco.io/slack
353+
[linkedin]: https://cpco.io/linkedin
354+
[twitter]: https://cpco.io/twitter
355+
[testimonial]: https://cpco.io/leave-testimonial
356+
[newsletter]: https://cpco.io/newsletter
357+
[email]: https://cpco.io/email
358+
[commercial_support]: https://cpco.io/commercial-support
359+
[we_love_open_source]: https://cpco.io/we-love-open-source
360+
[module_development]: https://cpco.io/module-development
361+
[terraform_modules]: https://cpco.io/terraform-modules
362+
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/terraform-aws-ec2-instance
363+
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/terraform-aws-ec2-instance
364+
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/terraform-aws-ec2-instance
365+
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/terraform-aws-ec2-instance
366+
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/terraform-aws-ec2-instance
367+
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/terraform-aws-ec2-instance
368+
[share_twitter]: https://twitter.com/intent/tweet/?text=terraform-aws-ec2-instance&url=https://github.com/cloudposse/terraform-aws-ec2-instance
369+
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=terraform-aws-ec2-instance&url=https://github.com/cloudposse/terraform-aws-ec2-instance
370+
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/terraform-aws-ec2-instance
371+
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/terraform-aws-ec2-instance
372+
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/terraform-aws-ec2-instance
373+
[share_email]: mailto:?subject=terraform-aws-ec2-instance&body=https://github.com/cloudposse/terraform-aws-ec2-instance
374+
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-ec2-instance?pixel&cs=github&cm=readme&an=terraform-aws-ec2-instance

README.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@
77
# Name of this project
88
name: terraform-aws-ec2-instance
99

10+
# Tags of this project
11+
tags:
12+
- aws
13+
- terraform
14+
- terraform-modules
15+
- platform
16+
- ec2
17+
- instance
18+
- security
19+
- ansible
20+
21+
# Categories of this project
22+
categories:
23+
- terraform-modules/platform
24+
1025
# Logo for this project
1126
#logo: docs/logo.png
1227

docs/targets.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
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
lint Lint terraform code
89
910
```

0 commit comments

Comments
 (0)