Skip to content

Commit a796a47

Browse files
authored
fix: updates to documentation (#71)
1 parent 76d1a94 commit a796a47

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
<!-- BEGIN MODULE HOOK -->
2-
3-
<!-- Update the title to match the module name and add a description -->
41
# Secrets Manager Private Cert module
52
[![Stable (Adopted)](https://img.shields.io/badge/Status-Stable%20(Adopted)-yellowgreen?style=plastic)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
63
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
@@ -13,10 +10,20 @@ This module creates a private certificate in an existing Secrets Manager instanc
1310
The module handles the following resource:
1411
- Secrets Manager private certificate
1512

16-
## Usage
13+
<!-- Below content is automatically populated via pre-commit hook -->
14+
<!-- BEGIN OVERVIEW HOOK -->
15+
## Overview
16+
* [terraform-ibm-secrets-manager-private-cert](#terraform-ibm-secrets-manager-private-cert)
17+
* [Examples](./examples)
18+
* [Default example](./examples/default)
19+
* [Contributing](#contributing)
20+
21+
## terraform-ibm-secrets-manager-private-cert
22+
<!-- END OVERVIEW HOOK -->
23+
24+
### Usage
1725

1826
```hcl
19-
# Replace "main" with a GIT release version to lock into a specific release
2027
module "secrets_manager_private_certificate" {
2128
source = "terraform-ibm-modules/secrets-manager-private-cert/ibm"
2229
version = "latest" # Replace "latest" with a release version to lock into a specific release
@@ -48,12 +55,6 @@ You need the following permissions to run this module.
4855
- `Administrator` platform access
4956
- `Manager` service access
5057

51-
<!-- END MODULE HOOK -->
52-
<!-- BEGIN EXAMPLES HOOK -->
53-
## Examples
54-
55-
- [ Default example](examples/default)
56-
<!-- END EXAMPLES HOOK -->
5758
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
5859
### Requirements
5960

@@ -105,13 +106,10 @@ No modules.
105106
| <a name="output_secret_crn"></a> [secret\_crn](#output\_secret\_crn) | Private certificates secrets manager secret CRN |
106107
| <a name="output_secret_id"></a> [secret\_id](#output\_secret\_id) | Private certificates secrets manager secret ID |
107108
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
108-
<!-- BEGIN CONTRIBUTING HOOK -->
109109

110110
<!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow -->
111111
## Contributing
112112

113113
You can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).
114114

115115
To set up your local development environment, see [Local development setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup) in the project documentation.
116-
<!-- Source for this readme file: https://github.com/terraform-ibm-modules/common-dev-assets/tree/main/module-assets/ci/module-template-automation -->
117-
<!-- END CONTRIBUTING HOOK -->

0 commit comments

Comments
 (0)