Skip to content

Commit

Permalink
Make glossary links more specific (#1800)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Sep 11, 2023
1 parent d753ceb commit a98bf58
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 11 deletions.
2 changes: 2 additions & 0 deletions docs/appendix/glossary/component.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
2 changes: 1 addition & 1 deletion docs/appendix/glossary/fragment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 2 additions & 2 deletions docs/appendix/glossary/location.md
Original file line number Diff line number Diff line change
@@ -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/).
4 changes: 2 additions & 2 deletions docs/appendix/glossary/organization.md
Original file line number Diff line number Diff line change
@@ -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:
---
Expand All @@ -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/).
2 changes: 2 additions & 0 deletions docs/appendix/glossary/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/appendix/glossary/remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
4 changes: 2 additions & 2 deletions docs/appendix/glossary/robot-config.md
Original file line number Diff line number Diff line change
@@ -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/).
4 changes: 2 additions & 2 deletions docs/appendix/glossary/robot.md
Original file line number Diff line number Diff line change
@@ -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/).
4 changes: 3 additions & 1 deletion docs/appendix/glossary/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
2 changes: 2 additions & 0 deletions docs/appendix/glossary/slam.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

0 comments on commit a98bf58

Please sign in to comment.