From a98bf5815bbfced425cc776aacdf2b9ef53593ac Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Mon, 11 Sep 2023 18:49:49 -0400 Subject: [PATCH] Make glossary links more specific (#1800) --- docs/appendix/glossary/component.md | 2 ++ docs/appendix/glossary/fragment.md | 2 +- docs/appendix/glossary/location.md | 4 ++-- docs/appendix/glossary/organization.md | 4 ++-- docs/appendix/glossary/process.md | 2 ++ docs/appendix/glossary/remote.md | 2 +- docs/appendix/glossary/robot-config.md | 4 ++-- docs/appendix/glossary/robot.md | 4 ++-- docs/appendix/glossary/service.md | 4 +++- docs/appendix/glossary/slam.md | 2 ++ 10 files changed, 19 insertions(+), 11 deletions(-) diff --git a/docs/appendix/glossary/component.md b/docs/appendix/glossary/component.md index 93112452f4..c65e2e32fc 100644 --- a/docs/appendix/glossary/component.md +++ b/docs/appendix/glossary/component.md @@ -7,3 +7,5 @@ aka: --- A resource that represents a physical component in a robot which a computer controls; for example, a servo, a camera, or an arm. + +For more information, see [Components](/components/). diff --git a/docs/appendix/glossary/fragment.md b/docs/appendix/glossary/fragment.md index 83b930d06f..4ffea1e973 100644 --- a/docs/appendix/glossary/fragment.md +++ b/docs/appendix/glossary/fragment.md @@ -9,4 +9,4 @@ aka: A reusable configuration block that you can share across multiple robots. For example, if you are deploying a specific mobile robot that is always physically connected the same way, you can create a fragment to make managing your fleet easy. -For more information see [Fragments](../../manage/configuration/#fragments). +For more information, see [Fragments](../../manage/configuration/#fragments). diff --git a/docs/appendix/glossary/location.md b/docs/appendix/glossary/location.md index 634598766c..40d4baf451 100644 --- a/docs/appendix/glossary/location.md +++ b/docs/appendix/glossary/location.md @@ -1,11 +1,11 @@ --- title: Location id: location -full_link: +full_link: /manage/fleet/locations/ short_description: A location is a virtual grouping of robots that allows you to organize robots and manage access to your fleet. aka: --- A location is a virtual grouping of robots that allows you to organize robots and manage access to your fleet. -For more information, see [Fleet Management](/manage/fleet/). +For more information, see [Manage Locations and Sub-Locations](/manage/fleet/locations/). diff --git a/docs/appendix/glossary/organization.md b/docs/appendix/glossary/organization.md index 016887e806..7d29c685c2 100644 --- a/docs/appendix/glossary/organization.md +++ b/docs/appendix/glossary/organization.md @@ -1,7 +1,7 @@ --- title: Organization id: organization -full_link: +full_link: /manage/fleet/organizations/ short_description: An organization is a group of one or more locations that helps you organize your fleet and manage who has access to your fleet. aka: --- @@ -10,4 +10,4 @@ An organization is the highest level grouping in the Viam platform, which genera Every {{< glossary_tooltip term_id="location" text="location" >}} is grouped into an organization. You can also have organizations for departments or other entities, or for personal use. -For more information, see [Fleet Management](/manage/fleet/). +For more information, see [Manage Organizations](/manage/fleet/organizations/). diff --git a/docs/appendix/glossary/process.md b/docs/appendix/glossary/process.md index eca60e735f..b9a3d7b78e 100644 --- a/docs/appendix/glossary/process.md +++ b/docs/appendix/glossary/process.md @@ -11,3 +11,5 @@ Processes are binaries or scripts that run on a {{< glossary_tooltip term_id="pa You can use processes to create a new local instance of `viam-server` to implement drivers for custom {{< glossary_tooltip term_id="component" text="components" >}}, or to run a client application, for example. They provide an OS-specific process managed by `viam-server` to either run once or indefinitely. For example, you could use a process to run a camera server. + +For information on how to configure a process, see [Configure a Robot](/manage/configuration/#processes). diff --git a/docs/appendix/glossary/remote.md b/docs/appendix/glossary/remote.md index 1ae4ca28e6..439c4dcd55 100644 --- a/docs/appendix/glossary/remote.md +++ b/docs/appendix/glossary/remote.md @@ -8,4 +8,4 @@ aka: A robot part which is controlled by another robot part. -For more information see [Robot Architecture: Parts, Sub-Parts and Remotes](../../manage/parts-and-remotes/). +For more information, see [Robot Architecture: Parts, Sub-Parts and Remotes](../../manage/parts-and-remotes/). diff --git a/docs/appendix/glossary/robot-config.md b/docs/appendix/glossary/robot-config.md index 56e714b2f0..94a4cb0662 100644 --- a/docs/appendix/glossary/robot-config.md +++ b/docs/appendix/glossary/robot-config.md @@ -1,11 +1,11 @@ --- title: Robot Config id: robot-config -full_link: +full_link: /manage/configuration/ short_description: The complete configuration of a single robot part. aka: --- The complete configuration of a single robot {{< glossary_tooltip term_id="part" text="part" >}}. -For more information see [Configuration](../../manage/configuration/). +For more information, see [Configuration](../../manage/configuration/). diff --git a/docs/appendix/glossary/robot.md b/docs/appendix/glossary/robot.md index 588494e4b5..6e49494c00 100644 --- a/docs/appendix/glossary/robot.md +++ b/docs/appendix/glossary/robot.md @@ -1,11 +1,11 @@ --- title: Robot id: robot -full_link: /manage/fleet/#robots +full_link: /manage/fleet/robots/ short_description: An organizational concept, consisting of either one part, or multiple parts working closely together to complete tasks. aka: --- An organizational concept, consisting of either one *{{< glossary_tooltip term_id="part" text="part" >}}*, or multiple *parts* working closely together to complete tasks. -For more information, see [Robots](../../manage/fleet/#robots). +For more information, see [Robots](../../manage/fleet/robots/). diff --git a/docs/appendix/glossary/service.md b/docs/appendix/glossary/service.md index 9c35d17410..e8f1cd4835 100644 --- a/docs/appendix/glossary/service.md +++ b/docs/appendix/glossary/service.md @@ -6,4 +6,6 @@ short_description: Built-in software packages for complex capabilities such as S aka: --- -Services are built-in software packages for complex capabilities such as SLAM, Computer Vision, Motion Planning, and Data Collection. +Services are built-in software packages for complex capabilities such as SLAM, computer vision, motion planning, and data collection. + +For more information, see [Services](/services/). diff --git a/docs/appendix/glossary/slam.md b/docs/appendix/glossary/slam.md index d5f3ea0db6..d7bec0a92d 100644 --- a/docs/appendix/glossary/slam.md +++ b/docs/appendix/glossary/slam.md @@ -7,3 +7,5 @@ aka: --- Simultaneous Localization and Mapping (SLAM) is an algorithm that allows your robot to create a map of its surroundings and find its location within that map. + +For more information, see [SLAM](/services/slam/).