From ccadd0f286f103444d5472ee4058cc596e1818c8 Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Fri, 31 Mar 2023 23:20:30 +0000 Subject: [PATCH] docs: tweak some words and fix a typo in agent-metadata.md --- docs/templates/agent-metadata.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/templates/agent-metadata.md b/docs/templates/agent-metadata.md index 1ee887ef21..5c253f7e90 100644 --- a/docs/templates/agent-metadata.md +++ b/docs/templates/agent-metadata.md @@ -6,17 +6,17 @@ Agent metadata is in an alpha state and may break or disappear at any time. ![agent-metadata](../images/agent-metadata.png) -With Agent Metadata, template admin can expose operational metrics from -their workspaces to their users. It is a sibling of [Resource Metadata](./resource-metadata.md). +With Agent Metadata, template admins can expose operational metrics from +their workspaces to their users. It is the dynamic complement of [Resource Metadata](./resource-metadata.md). See the [Terraform reference](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#metadata). ## Examples -All of these examples use [heredoc strings](https://developer.hashicorp.com/terraform/language/expressions/strings#heredoc-strings) for the script declaration. With heredoc strings you +All of these examples use [heredoc strings](https://developer.hashicorp.com/terraform/language/expressions/strings#heredoc-strings) for the script declaration. With heredoc strings, you can script without messy escape codes, just as if you were working in your terminal. -Here are useful agent metadata snippets for Linux agents: +Here's a standard set of metadata snippets for Linux agents: ```hcl resource "coder_agent" "main" { @@ -69,7 +69,7 @@ resource "coder_agent" "main" { ## Utilities [vmstat](https://linux.die.net/man/8/vmstat) is available in most Linux -distributions and contains virtual memory, CPU and IO statistics. Running `vmstat` +distributions and provides virtual memory, CPU and IO statistics. Running `vmstat` produces output that looks like: ```