Skip to content

Commit c2de86c

Browse files
ostermanaknysh
osterman
authored and
aknysh
committed
Update README (#24)
* Update README * Update badge
1 parent 72a2465 commit c2de86c

File tree

2 files changed

+47
-13
lines changed

2 files changed

+47
-13
lines changed

‎README.md‎

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
44

5-
# terraform-root-modules [![Build Status](https://travis-ci.org/cloudposse/terraform-root-modules.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-root-modules) [![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)
5+
# 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)
66

77

8-
This is a collection of reusable root modules for CloudPosse AWS accounts.
8+
This is a collection of reusable [Terraform root modules invocations](https://docs.cloudposse.com/terraform-modules/root/) for CloudPosse AWS accounts.
9+
10+
Terraform defines a "root module" as the current working directory holding the Terraform configuration files where the terraform apply or terraform get is run.
911

1012

1113
---
@@ -19,9 +21,13 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
1921

2022

2123

24+
25+
26+
27+
2228
## Usage
2329

24-
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
30+
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.
2531

2632
```dockerfile
2733
FROM cloudposse/terraform-root-modules:0.3.2 as terraform-root-modules
@@ -37,6 +43,10 @@ WORKDIR /conf/
3743

3844

3945

46+
## Examples
47+
48+
For example usage, refer to the "Related Projects" section. This is were we use `terraform-root-modules` to provision essential account-level infrastructure, among other services.
49+
4050

4151

4252
## Makefile Targets
@@ -62,6 +72,14 @@ Check out these related projects.
6272

6373

6474

75+
76+
## References
77+
78+
For additional context, refer to some of these links.
79+
80+
- [Cloud Posse Documentation](https://docs.cloudposse.com) - Complete documentation for the Cloud Posse solution
81+
82+
6583
## Help
6684

6785
**Got a question?**
@@ -140,6 +158,13 @@ See [LICENSE](LICENSE) for full details.
140158
under the License.
141159

142160

161+
162+
163+
164+
165+
166+
167+
143168
## Trademarks
144169

145170
All other trademarks referenced herein are the property of their respective owners.
@@ -169,16 +194,14 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi
169194

170195
### Contributors
171196

172-
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Marc Tamsky][tamsky_avatar]][tamsky_homepage]<br/>[Marc Tamsky][tamsky_homepage] |
173-
|---|---|---|---|
197+
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] |
198+
|---|---|---|
174199

175200
[osterman_homepage]: https://github.com/osterman
176201
[osterman_avatar]: https://github.com/osterman.png?size=150
177202
[goruha_homepage]: https://github.com/goruha
178203
[goruha_avatar]: https://github.com/goruha.png?size=150
179204
[aknysh_homepage]: https://github.com/aknysh
180205
[aknysh_avatar]: https://github.com/aknysh.png?size=150
181-
[tamsky_homepage]: https://github.com/tamsky
182-
[tamsky_avatar]: https://github.com/tamsky.png?size=150
183206

184207

‎README.yaml‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66

77
# Name of this project
8-
name: terraform-root-modules
8+
name: "terraform-root-modules"
99

1010
# Logo for this project
1111
#logo: docs/logo.png
@@ -14,20 +14,28 @@ name: terraform-root-modules
1414
license: "APACHE2"
1515

1616
# Canonical GitHub repo
17-
github_repo: cloudposse/terraform-root-modules
17+
github_repo: "cloudposse/terraform-root-modules"
1818

1919
# Badges to display
2020
badges:
2121
- name: "Build Status"
2222
image: "https://travis-ci.org/cloudposse/terraform-root-modules.svg?branch=master"
2323
url: "https://travis-ci.org/cloudposse/terraform-root-modules"
24+
- name: "Codefresh Build Status"
25+
image: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=terraform-root-modules&branch=master&pipelineName=terraform-root-modules&accountName=cloudposse&type=cf-1"
26+
url: "https://g.codefresh.io/pipelines/terraform-root-modules/builds"
2427
- name: "Latest Release"
2528
image: "https://img.shields.io/github/release/cloudposse/terraform-root-modules.svg"
2629
url: "https://github.com/cloudposse/terraform-root-modules/releases/latest"
2730
- name: "Slack Community"
2831
image: "https://slack.cloudposse.com/badge.svg"
2932
url: "https://slack.cloudposse.com"
3033

34+
references:
35+
- name: "Cloud Posse Documentation"
36+
description: "Complete documentation for the Cloud Posse solution"
37+
url: "https://docs.cloudposse.com"
38+
3139
related:
3240
- name: "audit.cloudposse.co"
3341
description: "Example Terraform Reference Architecture of a Geodesic Module for an Audit Logs Organization in AWS."
@@ -44,11 +52,13 @@ related:
4452

4553
# Short description of this project
4654
description: |-
47-
This is a collection of reusable root modules for CloudPosse AWS accounts.
55+
This is a collection of reusable [Terraform root modules invocations](https://docs.cloudposse.com/terraform-modules/root/) for CloudPosse AWS accounts.
56+
57+
Terraform defines a "root module" as the current working directory holding the Terraform configuration files where the terraform apply or terraform get is run.
4858
4959
# How to use this project
5060
usage: |-
51-
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
61+
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.
5262
5363
```dockerfile
5464
FROM cloudposse/terraform-root-modules:0.3.2 as terraform-root-modules
@@ -61,6 +71,9 @@ usage: |-
6171
WORKDIR /conf/
6272
```
6373
74+
examples: |-
75+
For example usage, refer to the "Related Projects" section. This is were we use `terraform-root-modules` to provision essential account-level infrastructure, among other services.
76+
6477
include:
6578
- "docs/targets.md"
6679
- "docs/terraform.md"
@@ -73,5 +86,3 @@ contributors:
7386
github: "goruha"
7487
- name: "Andriy Knysh"
7588
github: "aknysh"
76-
- name: "Marc Tamsky"
77-
github: "tamsky"

0 commit comments

Comments
 (0)