Skip to content

Commit 953fe67

Browse files
JessamyTnpentrel
authored andcommitted
Update links and aliases (#3808)
1 parent c5c9332 commit 953fe67

File tree

7 files changed

+25
-18
lines changed

7 files changed

+25
-18
lines changed

docs/operate/get-started/other-hardware/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ aliases:
1010
- /use-cases/create-module/
1111
- /how-tos/create-module/
1212
- /how-tos/sensor-module/
13+
- /registry/advanced/iterative-development/
1314
prev: "/operate/get-started/supported-hardware/"
1415
next: "/operate/get-started/other-hardware/hello-world-module/"
1516
---
@@ -831,7 +832,7 @@ viam module upload --version 1.0.0 --platform any module.tar.gz
831832

832833
For details on platform support, see [Using the `--platform` argument](/dev/tools/cli/#using-the---platform-argument).
833834

834-
For details about versioning, see [Module versioning](/operate/get-started/supported-hardware/#module-versioning).
835+
For details about versioning, see [Module versioning](/operate/reference/module-configuration/#module-versioning).
835836

836837
{{% alert title="Important" color="note" %}}
837838
The `viam module upload` command only supports one `platform` argument at a time.
@@ -879,7 +880,7 @@ You can use the following package and upload method if you opted not to enable c
879880

880881
For details on platform support, see [Using the `--platform` argument](/dev/tools/cli/#using-the---platform-argument).
881882

882-
For details about versioning, see [Module versioning](/operate/get-started/supported-hardware/#module-versioning).
883+
For details about versioning, see [Module versioning](/operate/reference/module-configuration/#module-versioning).
883884

884885
{{% alert title="Important" color="note" %}}
885886
The `viam module upload` command only supports one `platform` argument at a time.
@@ -897,7 +898,7 @@ From within your module's directory, run the `viam module upload` CLI command to
897898
viam module upload --version 1.0.0 --platform <platform> .
898899
```
899900
900-
For details about versioning, see [Module versioning](/operate/get-started/supported-hardware/#module-versioning).
901+
For details about versioning, see [Module versioning](/operate/reference/module-configuration/#module-versioning).
901902
902903
{{% alert title="Important" color="note" %}}
903904
The `viam module upload` command only supports one `platform` argument at a time.

docs/operate/get-started/other-hardware/cpp-module.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ draft: true # Take out Go and Python, and check updatedness before un-drafting.
1717
---
1818

1919
Viam provides built-in support for a variety of different {{< glossary_tooltip term_id="component" text="components" >}} and {{< glossary_tooltip term_id="service" text="services" >}}, as well as a registry full of {{< glossary_tooltip term_id="module" text="modules" >}} created by other users.
20-
If no [existing modules](/registry/modular-resources/) support your specific use case, you can write your own custom modular {{< glossary_tooltip term_id="resource" text="resources" >}} by creating a module, and either upload it to the [Viam Registry](https://app.viam.com/registry) to share it publicly, or deploy it to your machine as a local module without uploading it to the registry.
20+
If no [existing modules](/operate/get-started/supported-hardware/) support your specific use case, you can write your own custom modular {{< glossary_tooltip term_id="resource" text="resources" >}} by creating a module, and either upload it to the [Viam Registry](https://app.viam.com/registry) to share it publicly, or deploy it to your machine as a local module without uploading it to the registry.
2121

2222
Follow the instructions below to learn how to write a new module using your preferred language and its corresponding [Viam SDK](/dev/reference/sdks/), and then deploy it to your machines.
2323

@@ -175,7 +175,7 @@ For more Python module examples:
175175

176176
- See the [Python SDK `examples` directory](https://github.com/viamrobotics/viam-python-sdk/tree/main/examples) for sample module code of varying complexity.
177177
- For an example featuring a sensor, see [MCP300x](https://github.com/viam-labs/mcp300x-adc-sensor).
178-
- For additional examples use the [modular resources search](/registry/modular-resources/) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
178+
- For additional examples use the [modular resources search](/operate/get-started/supported-hardware/#for-use-with-64-bit-architecture) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
179179

180180
{{% /tab %}}
181181
{{% tab name="Go" %}}
@@ -190,7 +190,7 @@ For more Python module examples:
190190
For more Go module examples:
191191

192192
- See the [Go SDK `examples` directory](https://github.com/viamrobotics/rdk/blob/main/examples/) for sample module code of varying complexity.
193-
- For additional examples use the [modular resources search](/registry/modular-resources/) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
193+
- For additional examples use the [modular resources search](/operate/get-started/supported-hardware/#for-use-with-64-bit-architecture) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
194194

195195
{{% /tab %}}
196196
{{% tab name="C++" %}}
@@ -661,7 +661,7 @@ func (b *myBase) Close(ctx context.Context) error {
661661
{{< alert title="Note" color="note" >}}
662662
For an example featuring a sensor, see [MCP3004-8](https://github.com/mestcihazal/mcp3004-8-go).
663663

664-
For additional examples use the [modular resources search](/registry/modular-resources/) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
664+
For additional examples use the [modular resources search](/operate/get-started/supported-hardware/#for-use-with-64-bit-architecture) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
665665
{{< /alert >}}
666666

667667
When implementing built-in methods from the Viam Go SDK in your model, be sure your implementation of those methods returns any values designated in the built-in method's return signature, typed correctly.
@@ -1477,7 +1477,7 @@ Strings of the form `<INSERT X>` indicate placeholders that you need to replace
14771477
````md
14781478
# [`<INSERT MODULE NAME>` module](<INSERT LINK TO MODULE REPO>)
14791479
1480-
This [module](https://docs.viam.com/registry/modular-resources/) implements the [`<INSERT API TRIPLET>` API]<INSERT LINK TO DOCS (if applicable)> in an <INSERT MODEL> model.
1480+
This [module](https://docs.viam.com/operate/get-started/supported-hardware/) implements the [`<INSERT API TRIPLET>` API]<INSERT LINK TO DOCS (if applicable)> in an <INSERT MODEL> model.
14811481
With this model, you can...
14821482
14831483
## Requirements
@@ -1608,7 +1608,7 @@ To test: `make test`
16081608
16091609
{{% alert title="Tip" color="tip" %}}
16101610
1611-
If you would like to test your module locally against a target platform other than your development machine before uploading it, you can follow the steps for [Iterative module development](/registry/advanced/iterative-development/) to verify that any code changes you have made work as expected on your target platform.
1611+
If you would like to test your module locally against a target platform other than your development machine before uploading it, you can for example sync your code to an SBC with architecture that matches your target platform, and test your module there to verify that any code changes you have made work as expected on your target platform.
16121612
16131613
{{% /alert %}}
16141614
@@ -1661,7 +1661,7 @@ See [Update and manage modules you created](/operate/get-started/other-hardware/
16611661
You have now created a module, and are ready to deploy it to a fleet of machines.
16621662
There are two ways to deploy a module:
16631663
1664-
- Through the Viam Registry: Once you have uploaded your new module to the Viam Registry, [add the module to one or more machines in the Viam app](/registry/modular-resources/).
1664+
- Through the Viam Registry: Once you have uploaded your new module to the Viam Registry, [add the module to one or more machines in the Viam app](/operate/get-started/supported-hardware/#configure-hardware-on-your-machine).
16651665
You can also choose to configure [automated uploads for new module versions](/operate/get-started/other-hardware/manage-modules/#update-an-existing-module-using-a-github-action) through a continuous integration (CI) workflow, using a GitHub Action if desired, greatly simplifying how you push changes to your module to the registry as you make them.
16661666
- As a local module (without uploading it to the Viam app), as you did in the [Test your module locally step above](#test-your-module-locally).
16671667
This is a great way to test, but if you'd like to use the module on more machines it's easiest to add it to the registry either publicly or privately.

docs/operate/get-started/supported-hardware/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ layout: "docs"
66
type: "docs"
77
description: "Use supported hardware with your machine."
88
modulescript: true
9+
aliases:
10+
- program/extend/modular-resources/configure/
11+
- /extend/modular-resources/configure/
12+
- /modular-resources/configure/
13+
- /registry/configure/
14+
- /registry/modular-resources/
915
prev: "/operate/get-started/setup/"
1016
next: "/operate/get-started/other-hardware/"
1117
---

docs/operate/reference/architecture/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ If you want to add some other high-level software functionality beyond the built
8484

8585
<img src="https://assets-global.website-files.com/62fba5686b6d47fe2a1ed2a6/63334e5e19a68d329b1c5b0e_viam-overview-illustrations-manage.svg" alt="A diagram illustrating secure machine control." class="alignleft" style="width:270px;"></img>
8686

87-
Viam uses peer-to-peer communication, where all machines running `viam-server` or [`viam-micro-server`](/installation/viam-micro-server-dev/) (the version of `viam-server` for microcontrollers) communicate directly with each other as well as with the cloud.
87+
Viam uses peer-to-peer communication, where all machines running `viam-server` or [`viam-micro-server`](/operate/reference/viam-micro-server/) (the version of `viam-server` for microcontrollers) communicate directly with each other as well as with the cloud.
8888
This peer-to-peer connectivity is enabled by sending [gRPC commands over WebRTC connections](/operate/reference/architecture/machine-to-machine-comms/#low-level-inter-robotsdk-communication).
8989

9090
On startup, `viam-server` establishes a {{< glossary_tooltip term_id="webrtc" text="WebRTC" >}} connection with the [Viam app](https://app.viam.com).

docs/operate/reference/components/camera/esp32-camera.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ For example, the `OV2640` with a ribbon cable connected to an ESP32:
3333
{{< imgproc src="/components/camera/esp32-camera-2640.png" alt="Fake Camera on the ESP32" resize="300x" >}}
3434

3535
{{< alert title="Software requirements" color="note" >}}
36-
To use this model, you must follow the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/), which enables you to install and activate the ESP-IDF.
37-
At the step [Generate a new project from a template](/installation/viam-micro-server-dev/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
38-
Finish the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/) and return to this guide.
36+
To use this model, you must follow the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/), which enables you to install and activate the ESP-IDF.
37+
At the step [Generate a new project from a template](/operate/get-started/other-hardware/micro-module/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
38+
Finish the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/) and return to this guide.
3939
{{< /alert >}}
4040

4141
{{< alert title="Data management not supported" color="caution" >}}

docs/operate/reference/components/camera/fake-micro-server.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ A `fake` camera is a camera model for testing.
1818
The camera always returns the same image, which is an image of a circle inside a diamond.
1919

2020
{{< alert title="Software requirements" color="note" >}}
21-
To use this model, you must follow the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/), which enables you to install and activate the ESP-IDF.
22-
At the step [Generate a new project from a template](/installation/viam-micro-server-dev/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
23-
Finish the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/) and return to this guide.
21+
To use this model, you must follow the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/), which enables you to install and activate the ESP-IDF.
22+
At the step [Generate a new project from a template](/operate/get-started/other-hardware/micro-module/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
23+
Finish the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/) and return to this guide.
2424
{{< /alert >}}
2525

2626
{{< tabs name="Configure a Fake Camera" >}}

static/include/micro-rdk-hardware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ Your microcontroller should have at least the following resources available to w
1515
The main difference between the WROOM and WROVER is that the WROVER has additional RAM with the SPIRAM chip.
1616
If you would like to allow more than one concurrent connection to your device we recommend using the WROVER.
1717
The WROVER allows a max of 3 incoming gRPC connections (whether over HTTP2 or WebRTC).
18-
You can change this max by [building your own version of `viam-micro-server`](/installation/viam-micro-server-dev/).
18+
You can change this max by [building your own version of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/).
1919
{{< /alert >}}

0 commit comments

Comments
 (0)