Skip to content

Commit 8ade2bb

Browse files
authored
docs(readme): add toc and related module cross-links (#38)
1 parent 9a1d965 commit 8ade2bb

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
5353

5454

5555

56+
## Table of Contents
57+
- [Prerequisites](#prerequisites)
58+
- [Examples](#examples)
59+
- [Inputs](#inputs)
60+
- [Outputs](#outputs)
61+
- [Related Modules](#related-modules)
62+
- [Testing](#testing)
63+
5664
## Prerequisites
5765

5866
This module has a few dependencies:
@@ -121,6 +129,13 @@ Here is an example of how you can use this module in your inventory structure:
121129

122130

123131

132+
133+
## Related Modules
134+
135+
- [terraform-digitalocean-spaces](https://github.com/terraform-do-modules/terraform-digitalocean-spaces) — commonly used as CDN origin storage.
136+
- [terraform-digitalocean-certificate](https://github.com/terraform-do-modules/terraform-digitalocean-certificate) — SSL certificate management for custom CDN domains.
137+
- [terraform-digitalocean-domain](https://github.com/terraform-do-modules/terraform-digitalocean-domain) — DNS management for custom hostnames.
138+
124139
## Testing
125140
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
126141

0 commit comments

Comments
 (0)