DOCS-3161: Add docs for the maintenance window UI (#3701)

viamrobotics · Nov 29, 2024 · 38c3b62 · 38c3b62
1 parent a397b8f
commit 38c3b62
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 7 deletions.
diff --git a/docs/architecture/viam-server.md b/docs/architecture/viam-server.md
@@ -68,7 +68,17 @@ To avoid performing these updates until your machine is ready for maintenance, y
 A maintenance window consists of one or multiple conditions that determine if maintenance is currently allowed.
 To configure a maintenance window, you need to create a sensor that returns true when your maintenance conditions are met and false otherwise.
 
-Then, add the following configuration to your machine's JSON configuration:
+{{< tabs >}}
+{{% tab name="Builder UI" %}}
+
+To configure a maintenance window, click the **+** icon next to your {{< glossary_tooltip term_id="part" text="machine part" >}} in the left-hand menu of the **CONFIGURE** tab and select **Maintenance window**.
+
+In the new panel, specify the name of the sensor and the key for the value to be used to determine when maintenance is allowed.
+
+{{% /tab %}}
+{{% tab name="JSON" %}}
+
+To configure a maintenance window, add the following configuration to your machine's JSON configuration:
 
 ```json
 // components: [ ... ],
@@ -79,6 +89,9 @@ maintenance : {
 }
 ```
 
+{{% /tab %}}
+{{< /tabs >}}
+
 <!-- prettier-ignore -->
 | Attribute | Type | Required? | Description |
 | --------- | ---- | --------- | ----------- |

diff --git a/docs/fleet/fragments.md b/docs/fleet/fragments.md
@@ -71,7 +71,7 @@ If you have made edits, you will see an **edited from FRAGMENT NAME** indicator
 ![A motor config card with "edited from SCUTTLE101" in the upper right corner.](/fleet/fragment-edited.png)
 
 {{% /tab %}}
-{{% tab name="Raw JSON" %}}
+{{% tab name="JSON" %}}
 
 You can modify fragment fields in your machine's raw JSON config by using [update operators](https://www.mongodb.com/docs/manual/reference/operator/update/positional/#---update-).
 Viam supports all update operators except for `$setOnInsert`, `$`, `$[]`, and `$[<identifier>]`.

diff --git a/docs/tutorials/control/gamepad.md b/docs/tutorials/control/gamepad.md
@@ -150,7 +150,7 @@ For example:
 ![An example configuration for a base remote control service in the Viam app Config Builder.](/services/base-rc/base-rc-ui-config.png)
 
 {{% /tab %}}
-{{% tab name="Raw JSON" %}}
+{{% tab name="JSON" %}}
 
 Add the following configuration for your base remote control service, replacing `<your-base-name>` with your base's name:
 

diff --git a/docs/tutorials/get-started/blink-an-led.md b/docs/tutorials/get-started/blink-an-led.md
@@ -147,7 +147,7 @@ Your board component panel will look like this:
 {{<imgproc src="/tutorials/blink-an-led/board-config.png" resize="1200x" style="width: 650px" alt="Config tab of the Viam app showing the board configuration. The board is named 'local' and no attributes are configured.">}}
 
 {{% /tab %}}
-{{% tab name="Raw JSON" %}}
+{{% tab name="JSON" %}}
 
 If instead of using the config builder, you prefer to write raw JSON, switch to **JSON** mode on the **CONFIGURE** tab.
 Replace the contents of the config field with the following JSON configuration for your board:

diff --git a/docs/tutorials/projects/claw-game.md b/docs/tutorials/projects/claw-game.md
@@ -181,7 +181,7 @@ This is the only component in the main machine.
 Click **Save config** in the lower-left corner of the screen.
 
 {{% /tab %}}
-{{% tab name="Raw JSON" %}}
+{{% tab name="JSON" %}}
 
 On the [`Raw JSON` tab](/configure/#the-configure-tab), replace the configuration with the following JSON configuration for your board:
 
@@ -230,7 +230,7 @@ For more information on xArm6 configuration, see [Configure an xArm6 Arm](/compo
 Click **Save config** in the lower-left corner of the screen.
 
 {{% /tab %}}
-{{% tab name="Raw JSON" %}}
+{{% tab name="JSON" %}}
 
 On the [`Raw JSON` tab](/configure/#the-configure-tab), replace the configuration with the following JSON configuration for your arm:
 
@@ -295,7 +295,7 @@ Ours was 120mm for the width and 180mm for the height.
 Click **Save config** in the lower-left corner of the screen.
 
 {{% /tab %}}
-{{% tab name="Raw JSON" %}}
+{{% tab name="JSON" %}}
 
 On the [`Raw JSON` tab](/configure/#the-configure-tab), replace the configuration with the following JSON configuration for your arm and gripper: