From 13e0ff715264db808368f0f6f209a6301bf91491 Mon Sep 17 00:00:00 2001 From: Sierra Guequierre Date: Mon, 30 Oct 2023 10:43:06 -0400 Subject: [PATCH] Small changes --- docs/modular-resources/_index.md | 6 +++--- docs/modular-resources/create/_index.md | 4 ++-- docs/modular-resources/upload/_index.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/modular-resources/_index.md b/docs/modular-resources/_index.md index 8a961576be..0043c6df99 100644 --- a/docs/modular-resources/_index.md +++ b/docs/modular-resources/_index.md @@ -27,7 +27,7 @@ Viam provides built-in support for a variety of {{< glossary_tooltip term_id="re - Various types of hardware {{< glossary_tooltip term_id="component" text="components" >}}. - High-level functionality exposed as {{< glossary_tooltip term_id="service" text="services" >}}. -If the component or service you want to use for your project is not natively supported, you can [use _modular resources_ from the Viam Registry](#the-viam-registry) or [create your own modular resources](#modular-resources). +If the [component](/components/) or [service](/services/) you want to use for your project is not natively supported, you can [use _modular resources_ from the Viam Registry](#the-viam-registry) or [create your own modular resources](#modular-resources). You configure and manage modular resources the same way as built-in resources and use the same [standardized APIs](/program/apis/). ## The Viam Registry @@ -53,7 +53,7 @@ You can search the available modular resources from the Viam Registry here: To use a modular resource from the registry, add it from your robot's **Configuration** tab in [the Viam app](https://app.viam.com/), using the **Create component** button. -## Modular resources +## Create Your Own Modular Resources If none of the existing modular resources in the Viam registry support your use case, you can also create your own modular resources: @@ -69,7 +69,7 @@ To create a new modular resource: 1. Package your modular resource or modular resources as a {{< glossary_tooltip term_id="module" text="module" >}} and [upload the module to the Viam registry](/modular-resources/upload/) to make it available for deployment to robots. You can upload _private_ modules for your [organization](/manage/fleet/organizations/) or _public_ modules. 1. Once you have uploaded your module to the registry, you can [deploy and configure the module](/modular-resources/configure/) from [the Viam app](https://app.viam.com/). - If the added resource is a component, you can then test it using the [Control tab](/manage/fleet/#remote-control) and [program](/program/) it with Viam's Go or Python SDKs. + If the added resource is a component or service, you can then test it using the [Control tab](/manage/fleet/#remote-control) and [program](/program/) it with Viam's Go or Python SDKs. Some use cases may require you to extend the standardized API definitions or deploy custom components using a server on a remote part. For more information, see [Advanced Modular Resources](/modular-resources/advanced/). diff --git a/docs/modular-resources/create/_index.md b/docs/modular-resources/create/_index.md index d925bd3deb..82eaaf99a0 100644 --- a/docs/modular-resources/create/_index.md +++ b/docs/modular-resources/create/_index.md @@ -18,11 +18,11 @@ aliases: - "/extend/modular-resources/create/" --- -You can extend Viam by creating a custom {{< glossary_tooltip term_id="module" text="module" >}} that provides one or more modular {{< glossary_tooltip term_id="resource" text="resources" >}} ([components](/components/) and [services](/services/)) or {{< glossary_tooltip term_id="model" text="models" >}}, and can be added to any smart machine running on Viam. +You can extend Viam by creating a custom {{< glossary_tooltip term_id="module" text="module" >}} that provides one or more modular {{< glossary_tooltip term_id="resource" text="resources" >}} {{< glossary_tooltip term_id="model" text="models" >}} and can be added to any smart machine running on Viam. A common use case for modular resources is to create a new [model](/modular-resources/key-concepts/#models) that implements an existing Viam [API](/program/apis/). -Once you have created your modular resource, you can use the [Viam CLI](/manage/cli/) to [upload your modular resource](/modular-resources/upload/) to the [Viam registry](https://app.viam.com/registry), to share it with other Viam users or just to other users in your organization. +Once you have created your modular resource, you can use the [Viam CLI](/manage/cli/) to [upload your modular resource](/modular-resources/upload/) to the [Viam registry](https://app.viam.com/registry), to share it with other users in your organization or all other Viam users. You can also configure [automatic uploads of new versions of your module](/modular-resources/upload/#update-an-existing-module-using-a-github-action) as part of a continuous integration (CI) workflow, using a GitHub Action. You can also add your module to your robot as a [local module](/modular-resources/configure/#local-modules), without uploading it to the Viam registry. diff --git a/docs/modular-resources/upload/_index.md b/docs/modular-resources/upload/_index.md index 54e40d1bf3..7bea4986ff 100644 --- a/docs/modular-resources/upload/_index.md +++ b/docs/modular-resources/upload/_index.md @@ -18,7 +18,7 @@ aliases: - "/extend/modular-resources/upload/" --- -Once you have [created a custom module](/modular-resources/create/), you can use the [Viam CLI](/manage/cli/) to upload it to the Viam registry as a public module that ias shared with other Viam users, or as a private module that is shared only within your [organization](/manage/fleet/organizations/). +Once you have [created a custom module](/modular-resources/create/), use the [Viam CLI](/manage/cli/) to upload it to the Viam registry as a public module that is shared with other Viam users, or as a private module that is shared only within your [organization](/manage/fleet/organizations/). Once uploaded, you can also [update your modules](/modular-resources/upload/#update-an-existing-module).