diff --git a/README.md b/README.md index 5f8efe88..9b5182e1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Terraform IBM Observability agents module +# Terraform IBM Observability Agents Module [![Graduated (Supported)](https://img.shields.io/badge/Status-Graduated%20(Supported)-brightgreen)](https://terraform-ibm-modules.github.io/documentation/#/badge-status) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) @@ -87,8 +87,8 @@ The following is the corresponding DaemonSet configuration: For more information, see [Configuration for Kubernetes Metadata Filtering](https://github.com/logdna/logdna-agent-v2/blob/3.8/docs/KUBERNETES.md#configuration-for-kubernetes-metadata-filtering). -### Required IAM access policies -You need the following permissions to run this module. +### Required IAM Access Policies +You need the following permissions to run this module: - IAM Services - **IBM Cloud Activity Tracker** service @@ -166,6 +166,6 @@ No outputs. ## Contributing -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). +You can report issues and request features for this module in GitHub issues in the module repository. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md). -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. +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. diff --git a/examples/basic/README.md b/examples/basic/README.md index ab150588..01771030 100644 --- a/examples/basic/README.md +++ b/examples/basic/README.md @@ -1,4 +1,4 @@ -# Deploy basic observability agents +# Deploy Basic Observability Agents An end-to-end example that uses the module's default variable values. diff --git a/kubeconfig/README.md b/kubeconfig/README.md index e85afee8..c8a84fb1 100644 --- a/kubeconfig/README.md +++ b/kubeconfig/README.md @@ -1,2 +1 @@ -This directory must exist in source control so the `ibm_container_cluster_config` data lookup can use it to place the -config.yml used to connect to a kubernetes cluster. +This directory must exist in source control so that the `ibm_container_cluster_config` data lookup can use it to place the config.yml used to connect to a Kubernetes cluster. diff --git a/tests/README.md b/tests/README.md index 581aa046..352c72bc 100644 --- a/tests/README.md +++ b/tests/README.md @@ -2,7 +2,7 @@ # Tests -For information about how to create and run tests, see [Validation tests](https://terraform-ibm-modules.github.io/documentation/#/tests) in the project documentation. +For information about how to create and run tests, see [Validation Tests](https://terraform-ibm-modules.github.io/documentation/#/tests) in the project documentation.