From efa7c13286ee8924c94b7fff0e459eeec55a617d Mon Sep 17 00:00:00 2001 From: mbecker20 Date: Thu, 4 Jul 2024 19:08:48 -0700 Subject: [PATCH] docs --- docsite/docs/connecting-servers/setup-periphery.md | 2 +- docsite/docs/resources.md | 8 +++----- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docsite/docs/connecting-servers/setup-periphery.md b/docsite/docs/connecting-servers/setup-periphery.md index b2310524a..a333cf523 100644 --- a/docsite/docs/connecting-servers/setup-periphery.md +++ b/docsite/docs/connecting-servers/setup-periphery.md @@ -1,6 +1,6 @@ # Setup Monitor Periphery -The easiest way to setup periphery is to use the setup script: +The easiest way to setup periphery is to use the setup script (as root user): ```sh curl -sSL https://raw.githubusercontent.com/mbecker20/monitor/main/scripts/setup-periphery.py | python3 diff --git a/docsite/docs/resources.md b/docsite/docs/resources.md index 1c4cf43e6..772a4781a 100644 --- a/docsite/docs/resources.md +++ b/docsite/docs/resources.md @@ -1,10 +1,8 @@ # Resources -Entities like `Server`, `Deployment`, and `Build` are abstracted under a `Resource`. A server is a type of resource, a build is a type of resource, and so on. -All resources have common traits, such as a globally unique `name` and `id` amongst all other resources of the same resource type. -All resources can also be assigned `tags`, which can be used to group related resources. -For example, they can be grouped by environment (using `dev` or `prod` tags), or by function (`auth` or `ingress`), -or really by any way that fits best for your infra (they are all user defined). +Entities like `Server`, `Deployment`, and `Build` all fall under the `Resource` abstraction. A server is a type of resource, a build is a type of resource, and so on. +All resources have common traits, such as a unique `name` and `id` amongst all other resources of the same resource type. +All resources can be assigned `tags`, which can be used to group related resources. Here is a list of the resources and their description: - `Server`: Represents a connected server.