Skip to content

Commit b4ccd0f

Browse files
authored
docs: Update readme and PR template (#6)
* docs: update readme file - Editorial updates for style - Remove TOC because it's generated by GH - Change from 3rd person to 2nd person (you) * docs: update readme file and template - Editorial updates for style - Remove TOC because it's generated by GH - Change from 3rd person to 2nd person (you) - Update PR template to match module-template
1 parent 3aeef2a commit b4ccd0f

File tree

2 files changed

+35
-53
lines changed

2 files changed

+35
-53
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
### Description
22

3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
4-
List any dependencies that are required for this change.
3+
Please include a summary of the change and which issue is fixed. Also, please include the motivation and context for the change. List any dependencies that are required for this change.
54

6-
**Tick the relevant boxes:**
7-
- [ ] Bug fix (non-breaking change which fixes an issue)
8-
- [ ] New feature (non-breaking change which adds functionality)
5+
**Check the relevant boxes:**
6+
- [ ] Bug fix (nonbreaking change that fixes an issue)
7+
- [ ] New feature (nonbreaking change that adds functionality)
98
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10-
- [ ] Examples / tests (addition or updates of examples or tests)
9+
- [ ] Examples or tests (addition or updates of examples or tests)
1110
- [ ] Documentation update
12-
- [ ] CI related update (pipeline, etc)
11+
- [ ] CI related update (pipeline, etc.)
1312

14-
### Checklist:
13+
### Checklist
1514

16-
- [ ] If relevant, a test for the change has been added / updated as part of this PR.
17-
- [ ] If relevant, documentation for the change has been added / updated as part of this PR.
15+
- [ ] If relevant, a test for the change has been added or updated as part of this PR.
16+
- [ ] If relevant, documentation for the change has been added or updated as part of this PR.
1817

19-
### Merge:
20-
Merge using "Squash and merge" and ensure to use a relevant [conventional commit](https://www.conventionalcommits.org/) message based on the PR contents (this ultimately determines if a new version of the modules needs to be released, and if so, which semver number should be used).
18+
### Merge
19+
20+
- Merge using "Squash and merge".
21+
- Make sure to use a relevant [conventional commit](https://www.conventionalcommits.org/) message that is based on the PR contents. The commit message determines whether a new version of the modules needs to be released, and if so, which semver number to use).

README.md

Lines changed: 22 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,49 @@
1-
# IBM Secure Landing Zone VPC Module
1+
# IBM Secure Landing Zone VPC module
22

33
[![Build Status](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/actions/workflows/ci.yml/badge.svg)](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/actions/workflows/ci.yml)
44
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
55
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
66

7-
This module creates underlying VPC network components:
7+
This module creates the following IBM Cloud® Virtual Private Cloud (VPC) network components:
88

99
- VPC
10-
- Public Gateways
10+
- Public gateways
1111
- Subnets
1212
- Network ACLs
13-
- VPN Gateways
14-
- VPN Gateway Connections
13+
- VPN gateways
14+
- VPN gateway connections
1515

1616
![vpc-module](./.docs/vpc-module.png)
1717

18-
## Table of Contents
19-
20-
1. [VPC](#vpc)
21-
2. [Public Gateways](#public-gateways)
22-
3. [Network ACLs](#network-acls)
23-
4. [Subnets](#subnets)
24-
1. [Address Prefixes](#address-prefixes)
25-
2. [Subnets](#subnets-1)
26-
5. [VPN Gateways](#vpn-gateways)
27-
6. [Usage](#usage)
28-
7. [Required IAM access policies](#required-iam-access-policies)
29-
8. [Examples](#examples)
30-
9. [Usage](#usage)
31-
10. [Requirements](#requirements)
32-
11. [Modules](#modules)
33-
12. [Resources](#resources)
34-
13. [Inputs](#inputs)
35-
14. [Outputs](#outputs)
36-
3718
## VPC
3819

39-
This module creates a VPC in a resource group with optional Classic Access. The VPC and components are created in [main.tf](main.tf)
20+
This module creates a VPC in a resource group, and supports classic access. The VPC and components are specified in the [main.tf](main.tf) file.
4021

4122
---
4223

43-
## Public Gateways
24+
## Public gateways
4425

45-
This module allows a user to optionally create public gateways in the VPC in each of the three zones of the VPC's region.
26+
You can optionally create public gateways in the VPC in each of the three zones of the VPC's region.
4627

4728
---
4829

4930
## Network ACLs
5031

51-
This module creates any number of network ACLs with any number of rules. *(Note: by default, VPC Network ACLs have a maximum of 25 rules.)*
32+
You can create any number of network ACLs with any number of rules. By default, VPC network ACLs can have no more than 25 rules.
5233

5334
---
5435

5536
## Subnets
5637

57-
The [subnet.tf](./subnet.tf) file allows users to create subnets in 1, 2, or 3 zones. Public gateways can be optionally attached to each subnet. Each subnet can also be given as a parameter any ACL created within this module.
38+
You can create up to three zones in the [subnet.tf](subnet.tf) file. You can optionally attach public gateways to each subnet. And you can provide an ACL as a parameter to each subnet if the ACL is created by the module.
5839

59-
### Address Prefixes
40+
### Address prefixes
6041

61-
A CIDR block is created in the VPC for each subnet that will be provisioned
42+
A CIDR block is created in the VPC for each subnet that is provisioned.
6243

63-
### Subnets
44+
### Subnets variable
6445

65-
The type of the `subnets` variable is as follows:
46+
The following example shows the `subnets` variable.
6647

6748
```terraform
6849
object({
@@ -87,7 +68,7 @@ object({
8768
})
8869
```
8970

90-
While `zone-1`, `zone-2`, and `zone-3` are all lists, these lists are converted into an object before the resources are provisioned. This ensures that the addition or deletion of subnets will affect only the added or deleted subnets. Example:
71+
`zone-1`, `zone-2`, and `zone-3` are lists, but are converted to objects before the resources are provisioned. The conversion ensures that the addition or deletion of subnets affects only the added or deleted subnets, as shown in the following example.
9172

9273
```terraform
9374
module.subnets.ibm_is_subnet.subnet["gcat-multizone-subnet-a"]
@@ -100,9 +81,9 @@ module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-c"
10081

10182
---
10283

103-
## VPN Gateways
84+
## VPN gateways
10485

105-
This module can create any number of VPN gateways on any number of subnets using the `vpn_gateways` variable. For more about VPN gateways on VPC [read the documentation here](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn)
86+
You can create any number of VPN gateways on your subnets by using the `vpn_gateways` variable. For more information about VPN gateways on VPC, see [About site-to-site VPN gateways](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn) in the IBM Cloud docs.
10687

10788
---
10889

@@ -130,11 +111,11 @@ module vpc {
130111
You need the following permissions to run this module.
131112

132113
- IAM services
133-
- **VPC Infrastructure** services
134-
- `Editor` platform access
135-
- **No service access**
136-
- **Resource Group** \<your resource group>
137-
- `Viewer` resource group access
114+
- **VPC Infrastructure** services
115+
- `Editor` platform access
116+
- **No service access**
117+
- **Resource Group** \<your resource group>
118+
- `Viewer` resource group access
138119

139120
---
140121

0 commit comments

Comments
 (0)