From fe4aca168c67ba9428a925c88206879ded2903ee Mon Sep 17 00:00:00 2001 From: andf-viam <132301587+andf-viam@users.noreply.github.com> Date: Wed, 13 Sep 2023 16:46:39 -0400 Subject: [PATCH 1/3] DOCS-1107: Day-of MR tweaks (#1812) --- docs/appendix/glossary/module.md | 6 ++++-- docs/appendix/glossary/resource.md | 4 ++-- docs/extend/_index.md | 4 ++-- docs/extend/modular-resources/_index.md | 4 ++-- docs/extend/modular-resources/configure.md | 6 ++++++ docs/extend/modular-resources/create/_index.md | 7 ++++--- docs/extend/modular-resources/key-concepts.md | 10 +++++----- docs/manage/CLI.md | 9 +++++---- docs/manage/configuration.md | 2 +- 9 files changed, 31 insertions(+), 21 deletions(-) diff --git a/docs/appendix/glossary/module.md b/docs/appendix/glossary/module.md index 04045f4d5f..6bc9ef0058 100644 --- a/docs/appendix/glossary/module.md +++ b/docs/appendix/glossary/module.md @@ -2,10 +2,12 @@ title: Module id: module full_link: -short_description: Modular resources are a way to add resource types or models that are not built into Viam. +short_description: A module provides one or more modular resources, which add resource types or models that are not built into Viam. aka: --- -Modular resources are a way to add resource types or models that are not built into Viam. +A module provides one or more [modular resources](/extend/modular-resources/), which add resource types ([components](/components/) and [services](/services/)) or {{< glossary_tooltip term_id="model" text="models" >}} that are not built into Viam. + +You can extend the capabilities of Viam on your robot by [creating your own module](/extend/modular-resources/create/) or [adding an existing module from the Viam registry](/extend/modular-resources/configure/). For more information see the [modular resource documentation](/extend/modular-resources/). diff --git a/docs/appendix/glossary/resource.md b/docs/appendix/glossary/resource.md index 9a7eef8ac9..23ffd610c2 100644 --- a/docs/appendix/glossary/resource.md +++ b/docs/appendix/glossary/resource.md @@ -8,11 +8,11 @@ aka: Resources are individual, addressable elements of a robot. -{{< glossary_tooltip term_id="part" text="Parts" >}} operate multiple types of resources: +{{< glossary_tooltip term_id="part" text="Parts" >}} can operate multiple types of resources: - physical {{< glossary_tooltip term_id="component" text="components" >}} - software {{< glossary_tooltip term_id="service" text="services" >}} -- {{< glossary_tooltip term_id="module" text="modules" >}} +- [modular resources](/extend/modular-resources/) provided by {{< glossary_tooltip term_id="module" text="modules" >}} - {{< glossary_tooltip term_id="process" text="processes" >}} Each part has local resources and can also have resources from another {{< glossary_tooltip term_id="remote" text="remote">}} robot part. diff --git a/docs/extend/_index.md b/docs/extend/_index.md index c597873ead..47b82c28c2 100644 --- a/docs/extend/_index.md +++ b/docs/extend/_index.md @@ -16,7 +16,7 @@ Viam's [Robot Development Kit (RDK)](/internals/rdk/) provides built-in support - Various types of hardware [components](/components/). - High-level functionality exposed as [services](/services/). -However, if you want to work with a new hardware component that is not already supported by Viam, or want to introduce a new software service or service model to support additional functionality on your robot, you can extend Viam by adding a {{< glossary_tooltip term_id="module" text="modular resource" >}} to your robot. +However, if you want to work with a new hardware component that is not already supported by Viam, or want to introduce a new software service or service model to support additional functionality on your robot, you can extend Viam by adding a [modular resource](/extend/modular-resources/) to your robot. Click on the cards below for instructions on implementing modular resources through {{< glossary_tooltip term_id="module" text="modules" >}} or {{< glossary_tooltip term_id="remote" text="remotes" >}}: @@ -27,7 +27,7 @@ Click on the cards below for instructions on implementing modular resources thro {{% alert title="Tip" color="tip" %}} -{{< glossary_tooltip term_id="module" text="Modular resources" >}} are the preferred method of creating custom resource implementations with the [Python and Go SDKs](/program/). +[Modular resources](/extend/modular-resources/) provided by custom {{< glossary_tooltip term_id="module" text="modules" >}} are the preferred method of creating custom resource implementations. [Adding a custom component as a remote](/extend/custom-components-remotes/) is recommended if you are hosting `viam-server` on a non-Linux system or have another issue with compilation. diff --git a/docs/extend/modular-resources/_index.md b/docs/extend/modular-resources/_index.md index bbb60e6a2c..2c69031b72 100644 --- a/docs/extend/modular-resources/_index.md +++ b/docs/extend/modular-resources/_index.md @@ -21,7 +21,7 @@ For example, you can: - **Implement fully custom logic:** If your robot runs specialty or proprietary logic, and you want to use Viam to manage and control that logic, such as when managing a software development lifecyle, you can implement your own custom logic by wrapping the generic API. -These custom implementations are called {{< glossary_tooltip term_id="module" text="modular resources" >}}, and are made available for use on a robot through [modules](/extend/modular-resources/key-concepts/#modules). +These custom implementations are called *modular resources*, and are made available for use on a robot through {{< glossary_tooltip term_id="module" text="modules" >}}. A module can provide one or more modular resources, and can be added to your robot from the Viam registry. ## The Viam Registry @@ -29,7 +29,7 @@ A module can provide one or more modular resources, and can be added to your rob The [Viam registry](https://app.viam.com/registry) allows hardware and software engineers to collaborate on their robotics projects by writing and sharing custom modules with each other. You can add a module from the Viam registry directly from your robot's **Configuration** tab in [the Viam app](https://app.viam.com/), using the **+ Create component** button. -The code behind any modular resource can be packaged as a [module](/extend/modular-resources/key-concepts/#modules) and uploaded to the Viam registry. +The code behind any modular resource can be packaged as a {{< glossary_tooltip term_id="module" text="module" >}} and uploaded to the Viam registry. Once the module has been uploaded to the Registry, you can [deploy the module](/extend/modular-resources/configure/) to any robot in your organization from [the Viam app](https://app.viam.com/). ### Uploading to Viam Registry diff --git a/docs/extend/modular-resources/configure.md b/docs/extend/modular-resources/configure.md index 1d7a73dc4d..0825ed7547 100644 --- a/docs/extend/modular-resources/configure.md +++ b/docs/extend/modular-resources/configure.md @@ -42,6 +42,9 @@ To add a modular [component](/components/) from the Viam registry to your robot: {{}} + Be sure the modular component you select supports the [platform](/manage/cli/#using-the---platform-argument) you intend to use it with, such as `linux arm64`. + You can see which platforms the module supports at bottom of the module information screen before you add it. + When you add a module from the Viam registry, the custom modular component it provides appears under the **Components** subtab like any other component. You can also find [the module itself](#configure-a-module-from-the-viam-registry) listed as **Deployed** under the **Modules** subtab. @@ -68,6 +71,9 @@ To add a modular [service](/services/) from the Viam registry to your robot: {{}} + Be sure the modular service you select supports the [platform](/manage/cli/#using-the---platform-argument) you intend to use it with, such as `linux arm64`. + You can see which platforms the module supports at bottom of the module information screen before you add it. + When you add a module from the Viam registry, the custom modular service it provides appears under the **Services** subtab like any other service. You can also find [the module itself](#configure-a-module-from-the-viam-registry) listed as **Deployed** under the **Modules** subtab. diff --git a/docs/extend/modular-resources/create/_index.md b/docs/extend/modular-resources/create/_index.md index 21c314a38a..dd73c9fbe5 100644 --- a/docs/extend/modular-resources/create/_index.md +++ b/docs/extend/modular-resources/create/_index.md @@ -8,11 +8,12 @@ description: "Use the Viam module system to implement modular resources that can no_list: true --- -You can extend Viam by creating a custom [module](/extend/modular-resources/key-concepts/#modules) that provides one or more modular {{< glossary_tooltip term_id="resource" text="resources" >}} ([components](/components/) and [services](/services/)), and can be added to any robot 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" >}} ([components](/components/) and [services](/services/)) or {{< glossary_tooltip term_id="model" text="models" >}}, and can be added to any robot running on Viam. -A common use case for modular resources is to create a new model that implements an existing Viam API. +A common use case for modular resources is to create a new [model](/extend/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](/extend/modular-resources/upload/) to the Viam 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](/extend/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. +You can also configure [automatic uploads of new versions of your module](/extend/modular-resources/upload/#update-an-existing-module-using-a-github-action) as part of a continuous integration (CI) workflow, using a GitHub Action. Alternatively, you can add your module locally to your robot without uploading to the Viam registry. diff --git a/docs/extend/modular-resources/key-concepts.md b/docs/extend/modular-resources/key-concepts.md index c7e3911486..a110f14e84 100644 --- a/docs/extend/modular-resources/key-concepts.md +++ b/docs/extend/modular-resources/key-concepts.md @@ -35,8 +35,8 @@ A modular resource runs in the module process. This differs from built-in resour ## Models -A *model* describes a specific implementation of a [resource](#resources) that implements (speaks) its API. -Models allow you to control different instances of resource with a consistent interface, even if the underlying implementation differs. +A *model* describes a specific implementation of a [resource](#resources) that implements (speaks) its [API](/program/apis/). +Models allow you to control different instances of a resource with a consistent interface, even if the underlying implementation differs. For example, some DC motors communicate using [GPIO](/components/board/), while other DC motors use serial protocols like the [SPI bus](/components/board/#spis). Regardless, you can power any motor model that implements the `rdk:component:motor` API with the `SetPower()` method. @@ -47,7 +47,7 @@ See [Naming your model](/extend/modular-resources/key-concepts/#naming-your-mode Models are either: - Built into the RDK, and included when you [install `viam-server`](/installation/) or when you use one of the [Viam SDKs](/program/apis/). -- Provided in custom modules available for download from the [Viam registry](https://app.viam.com/registry), and are written by either Viam or community users. +- Provided in [custom modules](#modules) available for download from the [Viam registry](https://app.viam.com/registry), and are written by either Viam or community users. ### Built-in models @@ -66,13 +66,13 @@ These models run outside `viam-server` as a separate process. #### Valid APIs to implement in your model -When implementing a custom model of an existing [component](/components/), valid [APIs](/program/apis/) are always: +When implementing a custom [model](#models) of an existing [component](/components/), valid [APIs](/program/apis/) are always: - `namespace`: `rdk` - `type`: `component` - `subtype`: any one of [these component proto files](https://github.com/viamrobotics/api/tree/main/proto/viam/component). -When implementing a custom model of an existing [service](/services/), valid [APIs](/program/apis/) are always +When implementing a custom [model](#models) of an existing [service](/services/), valid [APIs](/program/apis/) are always - `namespace`: `rdk` - `type`: `service` diff --git a/docs/manage/CLI.md b/docs/manage/CLI.md index f9cf21b787..a4f272d5b0 100644 --- a/docs/manage/CLI.md +++ b/docs/manage/CLI.md @@ -287,12 +287,11 @@ viam logout ### module -The `module` command allows to you to manage [custom modules](/extend/modular-resources/). +The `module` command allows to you to manage custom {{< glossary_tooltip term_id="module" text="modules" >}} This includes: -* Creating a new custom modular resource -* Updating an existing module with new changes -* Uploading a new module to the Viam registry +* Creating a new custom {{< glossary_tooltip term_id="resource" text="modular resource" >}} +* Uploading a new module to the [Viam registry](https://app.viam.com/registry) * Updating an existing module in the Viam registry ```sh {class="command-line" data-prompt="$"} @@ -468,6 +467,8 @@ If the two namespaces do not match, the command will return an error. See [Upload a custom module](/extend/modular-resources/upload/#upload-a-custom-module) and [Update an existing module](/extend/modular-resources/upload/#update-an-existing-module) for a detailed walkthrough of the `viam module` commands. +See [Modular resources](/extend/modular-resources/) for a conceptual overview of modules and the modular resource system at Viam. + ### organization The *organization* command allows you to create a new organization API key. diff --git a/docs/manage/configuration.md b/docs/manage/configuration.md index 654fcb4c33..789427bd63 100644 --- a/docs/manage/configuration.md +++ b/docs/manage/configuration.md @@ -131,7 +131,7 @@ The **Config** tab has subtabs for each section of your robot's config: - [Components](#components): Components are the hardware of your robot. - [Services](#services): Services are the software that runs on your robot. -- [Modules](#modules): Modular resources are a way to add resource types or models that are not built into Viam. +- [Modules](#modules): {{< glossary_tooltip term_id="module" text="Modules" >}} provide [modular resources](/extend/modular-resources/), which are a way to add resource types or models that are not built into Viam. - [Remotes](#remotes): Remotes are a way to connect two separate robots so one can access the resources of the other. - [Processes](#processes): Processes automatically run specified scripts when the robot boots. - [Fragments](#fragments): Fragments are a way of sharing and managing identical configuration files (or parts of config files) across multiple robots. From 45e9937e31748977ae2c4007892fee895ac18aba Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Thu, 14 Sep 2023 10:34:16 -0400 Subject: [PATCH 2/3] DOCS-944: Update link to work on staging (#1823) --- layouts/_default/_markup/render-link.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/_default/_markup/render-link.html b/layouts/_default/_markup/render-link.html index 5d9254952d..259a429d10 100644 --- a/layouts/_default/_markup/render-link.html +++ b/layouts/_default/_markup/render-link.html @@ -1 +1 @@ -{{if or (in .Text "here") (in .Text "www") (in .Text "https") }}{{- errorf "Link text is too non-descriptive: %q" .Text -}}{{ end }}{{ .Text | safeHTML }} \ No newline at end of file +{{if or (in .Text "here") (in .Text "www") (in .Text "https") }}{{- errorf "Link text is too non-descriptive: %q" .Text -}}{{ end }}{{ .Text | safeHTML }} \ No newline at end of file From e832746e7099da1c47cc3768202e398e05828b4b Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Thu, 14 Sep 2023 10:38:27 -0400 Subject: [PATCH 3/3] Fix search box on mobile (#1824) --- assets/scss/_styles_project.scss | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index 035cdf6895..984aee079c 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -1307,6 +1307,12 @@ a.ais-Pagination-link:hover { flex-grow: 1; } +@media (max-width: 600px) { +.algolia-autocomplete .ds-dropdown-menu { + min-width: 90% !important; +} +} + .ds-dataset-1, .ds-dataset-2, .ds-dataset-3 { max-height: 500px !important; }