Skip to content

Commit f973d85

Browse files
authored
feature: update readme yaml and rebuild readme md (#23)
1 parent a0c3a16 commit f973d85

File tree

3 files changed

+113
-39
lines changed

3 files changed

+113
-39
lines changed

README.md

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

@@ -16,7 +17,17 @@ This module requires [AWS Provider](https://github.com/terraform-providers/terra
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

@@ -82,19 +98,19 @@ module "dynamodb_table" {
8298
]
8399
84100
local_secondary_index_map = [
85-
{
86-
name = "TimestampSortIndex"
87-
range_key = "Timestamp"
88-
projection_type = "INCLUDE"
89-
non_key_attributes = ["HashKey", "RangeKey"]
90-
},
91-
{
92-
name = "HighWaterIndex"
93-
range_key = "Timestamp"
94-
projection_type = "INCLUDE"
95-
non_key_attributes = ["HashKey", "RangeKey"]
96-
}
97-
]
101+
{
102+
name = "TimestampSortIndex"
103+
range_key = "Timestamp"
104+
projection_type = "INCLUDE"
105+
non_key_attributes = ["HashKey", "RangeKey"]
106+
},
107+
{
108+
name = "HighWaterIndex"
109+
range_key = "Timestamp"
110+
projection_type = "INCLUDE"
111+
non_key_attributes = ["HashKey", "RangeKey"]
112+
}
113+
]
98114
99115
global_secondary_index_map = [
100116
{
@@ -150,9 +166,9 @@ Available targets:
150166
| enable_encryption | Enable DynamoDB server-side encryption | string | `true` | no |
151167
| enable_point_in_time_recovery | Enable DynamoDB point in time recovery | string | `true` | no |
152168
| enable_streams | Enable DynamoDB streams | string | `false` | no |
153-
| local_secondary_index_map | Additional local secondary indexes in the form of a list of mapped values | list | `<list>` | no |
154169
| global_secondary_index_map | Additional global secondary indexes in the form of a list of mapped values | list | `<list>` | no |
155170
| hash_key | DynamoDB table Hash Key | string | - | yes |
171+
| local_secondary_index_map | Additional local secondary indexes in the form of a list of mapped values | list | `<list>` | no |
156172
| name | Name (e.g. `app` or `cluster`) | string | - | yes |
157173
| namespace | Namespace (e.g. `eg` or `cp`) | string | - | yes |
158174
| range_key | DynamoDB table Range Key | string | `` | no |
@@ -166,6 +182,7 @@ Available targets:
166182
| Name | Description |
167183
|------|-------------|
168184
| global_secondary_index_names | DynamoDB secondary index names |
185+
| local_secondary_index_names | DynamoDB local index names |
169186
| table_arn | DynamoDB table ARN |
170187
| table_id | DynamoDB table ID |
171188
| table_name | DynamoDB table name |
@@ -175,6 +192,13 @@ Available targets:
175192

176193

177194

195+
## Share the Love
196+
197+
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-aws-dynamodb)! (it helps us **a lot**)
198+
199+
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
200+
201+
178202
## Related Projects
179203

180204
Check out these related projects.
@@ -195,26 +219,38 @@ Check out these related projects.
195219

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

222+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
223+
198224
## Commercial Support
199225

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

202228
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.
203229

204-
[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com)
230+
[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)][email]
205231

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

214240

215-
## Community Forum
216241

217-
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.
242+
## Terraform Module Development
243+
244+
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.
245+
246+
247+
## Slack Community
248+
249+
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.
250+
251+
## Newsletter
252+
253+
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.
218254

219255
## Contributing
220256

@@ -224,7 +260,7 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-dynam
224260

225261
### Developing
226262

227-
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:hello@cloudposse.com).
263+
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].
228264

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

@@ -239,7 +275,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
239275

240276
## Copyright
241277

242-
Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
278+
Copyright © 2017-2018 [Cloud Posse, LLC](https://cpco.io/copyright)
243279

244280

245281

@@ -280,26 +316,16 @@ All other trademarks referenced herein are the property of their respective owne
280316

281317
## About
282318

283-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>
319+
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
284320

285-
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
321+
[![Cloud Posse][logo]][website]
286322

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

289-
We offer paid support on all of our projects.
325+
We offer [paid support][commercial_support] on all of our projects.
290326

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

293-
[docs]: https://docs.cloudposse.com/
294-
[website]: https://cloudposse.com/
295-
[github]: https://github.com/cloudposse/
296-
[commercial_support]: https://github.com/orgs/cloudposse/projects
297-
[jobs]: https://cloudposse.com/jobs/
298-
[hire]: https://cloudposse.com/contact/
299-
[slack]: https://slack.cloudposse.com/
300-
[linkedin]: https://www.linkedin.com/company/cloudposse
301-
[twitter]: https://twitter.com/cloudposse/
302-
[email]: mailto:hello@cloudposse.com
303329

304330

305331
### Contributors
@@ -317,3 +343,36 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi
317343
[darend_avatar]: https://github.com/darend.png?size=150
318344

319345

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

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-dynamodb
99

10+
# Tags of this project
11+
tags:
12+
- aws
13+
- terraform
14+
- terraform-modules
15+
- databases
16+
- autoscaling
17+
- dynamodb
18+
- dynamodb-table
19+
- dynamodb-database
20+
21+
# Categories of this project
22+
categories:
23+
- terraform-modules/databases
24+
1025
# Logo for this project
1126
#logo: docs/logo.png
1227

docs/terraform.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
| enable_encryption | Enable DynamoDB server-side encryption | string | `true` | no |
1717
| enable_point_in_time_recovery | Enable DynamoDB point in time recovery | string | `true` | no |
1818
| enable_streams | Enable DynamoDB streams | string | `false` | no |
19-
| local_secondary_index_map | local secondary indexes in the form of a list of mapped values | list | `<list>` | no |
2019
| global_secondary_index_map | Additional global secondary indexes in the form of a list of mapped values | list | `<list>` | no |
2120
| hash_key | DynamoDB table Hash Key | string | - | yes |
21+
| local_secondary_index_map | Additional local secondary indexes in the form of a list of mapped values | list | `<list>` | no |
2222
| name | Name (e.g. `app` or `cluster`) | string | - | yes |
2323
| namespace | Namespace (e.g. `eg` or `cp`) | string | - | yes |
2424
| range_key | DynamoDB table Range Key | string | `` | no |
@@ -31,8 +31,8 @@
3131

3232
| Name | Description |
3333
|------|-------------|
34-
| local_secondary_index_names | DynamoDB local index names |
3534
| global_secondary_index_names | DynamoDB secondary index names |
35+
| local_secondary_index_names | DynamoDB local index names |
3636
| table_arn | DynamoDB table ARN |
3737
| table_id | DynamoDB table ID |
3838
| table_name | DynamoDB table name |

0 commit comments

Comments
 (0)