docs: Update examples descriptions and small details.

terraform-google-modules · Oct 31, 2024 · 37be4d2 · 37be4d2
1 parent 605f607
commit 37be4d2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/examples/ops_agent_policy_install_all/README.md b/examples/ops_agent_policy_install_all/README.md
@@ -1,6 +1,6 @@
 # Ops Agent Policy Example
 
-This example illustrates how to use the `ops-agent-policy` module to install the ops agent on all VMs in a zone.
+This example illustrates how to use the `ops-agent-policy` module to install the ops agent on all VMs within a GCP project.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs

diff --git a/examples/ops_agent_policy_install_all_in_region/README.md b/examples/ops_agent_policy_install_all_in_region/README.md
@@ -1,6 +1,6 @@
 # Ops Agent Policy Example
 
-This example illustrates how to use the `ops-agent-policy` module to install the ops agent on all VMs in a zone.
+This example illustrates how to use the `ops-agent-policy` module to install the ops agent on all VMs in a region.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs

diff --git a/modules/ops-agent-policy/README.md b/modules/ops-agent-policy/README.md
@@ -1,6 +1,6 @@
 # Agent Policy
 
-This module is used to install/uninstall the ops agent in GCE.
+This module is used to install/uninstall the ops agent in Google Cloud Engine VM's using [ops agent policies](https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent/agent-policies).
 
 ## Usage
 
@@ -32,7 +32,7 @@ module "ops_agent_policy" {
 }
 ```
 
-Functional examples are included in the [examples](./../../examples) directory.
+Functional examples are included in the [examples](./../../examples) directory with the prefix `ops_agent_policy`.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs