Skip to content

Commit 5bc14c5

Browse files
authored
DOCS-4431: Update restart button (#4723)
1 parent d34905f commit 5bc14c5

File tree

6 files changed

+57
-21
lines changed

6 files changed

+57
-21
lines changed

docs/manage/reference/viam-agent/manage-viam-agent.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,44 @@ aliases:
1919
{{< tabs >}}
2020
{{% tab name="Linux" %}}
2121

22-
- To start `viam-agent`:
22+
- To restart `viam-agent`:
23+
24+
{{< alert title="Alert" color="note" >}}
25+
When you restart `viam-agent`, the agent will restart `viam-server` as well.
26+
{{< /alert >}}
27+
28+
{{< tabs >}}
29+
{{% tab name="Web UI" %}}
30+
31+
1. Navigate to your machine in [Viam](https://app.viam.com).
32+
1. Click on the machine status indicator next to the machine name.
33+
1. Click on the restart arrow symbol.
34+
This will restart `viam-server` and `viam-agent`.
35+
36+
{{% /tab %}}
37+
{{% tab name="Shell" %}}
2338

2439
```sh {class="command-line" data-prompt="$"}
25-
sudo systemctl start viam-agent
40+
sudo systemctl restart viam-agent
2641
```
2742

28-
- To stop `viam-agent`:
43+
{{% /tab %}}
44+
{{< /tabs >}}
45+
46+
- To start `viam-agent`:
2947

3048
```sh {class="command-line" data-prompt="$"}
31-
sudo systemctl stop viam-agent
49+
sudo systemctl start viam-agent
3250
```
3351

34-
{{< alert title="Alert" color="note" >}}
35-
When you stop `viam-agent`, the agent will stop `viam-server` as well.
36-
{{< /alert >}}
37-
38-
- To restart `viam-agent`:
52+
- To stop `viam-agent`:
3953

4054
{{< alert title="Alert" color="note" >}}
41-
When you restart `viam-agent`, the agent will restart `viam-server` as well.
55+
When you stop `viam-agent`, the agent will stop `viam-server` as well.
4256
{{< /alert >}}
4357

4458
```sh {class="command-line" data-prompt="$"}
45-
sudo systemctl restart viam-agent
59+
sudo systemctl stop viam-agent
4660
```
4761

4862
- To completely uninstall `viam-agent` and `viam-server`, run the following command:
@@ -61,7 +75,8 @@ You can only restore this file if you have access to the machine configuration.
6175
{{% /tab %}}
6276
{{% tab name="Windows native" %}}
6377

64-
On Windows, you can manage `viam-agent` using the Services GUI or the command line:
78+
On Windows, you can manage `viam-agent` using the Services GUI or the command line.
79+
You can also use the Viam web UI to restart `viam-agent`.
6580

6681
{{< tabs >}}
6782
{{% tab name="Services GUI" %}}
@@ -72,7 +87,7 @@ On Windows, you can manage `viam-agent` using the Services GUI or the command li
7287

7388
{{<imgproc src="/manage/viam-agent-windows-services-manager.png" resize="x1100" declaredimensions=true alt="Windows Services manager with viam-agent highlighted." style="max-width:600px" class="shadow imgzoom" >}}
7489

75-
1. Use the **Start Service**, **Stop Service**, and **Restart Service** buttons to manage `viam-agent`.
90+
1. Use the **Restart Service**, **Stop Service**, and **Start Service** buttons to manage `viam-agent`.
7691

7792
1. To change the startup type of `viam-agent`, right-click on `viam-agent` and select **Properties**.
7893
Select your desired startup type from the **Startup type** dropdown menu.
@@ -111,6 +126,14 @@ On Windows, you can manage `viam-agent` using the Services GUI or the command li
111126
Set-Service -Name "viam-agent" -StartupType Automatic
112127
```
113128

129+
{{% /tab %}}
130+
{{% tab name="Web UI" %}}
131+
132+
1. Navigate to your machine in [Viam](https://app.viam.com).
133+
1. Click on the machine status indicator next to the machine name.
134+
1. Click on the restart arrow symbol.
135+
This will restart `viam-server` and `viam-agent`.
136+
114137
{{% /tab %}}
115138
{{< /tabs >}}
116139

docs/manage/troubleshoot/troubleshoot.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,8 @@ To remotely access your machine from your terminal:
277277
1. Select the part status dropdown to the right of your machine's name on the top of the page.
278278
{{<imgproc src="configure/machine-part-info.png" resize="500x" declaredimensions=true alt="machine cloud credentials button on the machine part info dropdown" class="shadow" >}}
279279
1. If you installed `viam-server` with `viam-agent` you will see a **Restart** button. Click it.
280+
Both `viam-server` and `viam-agent` will restart.
281+
280282
If you do not see the **Restart** button, click the **...** menu on the right side of the machine part's card, and select **Restart part**.
281283
If restarting the machine part does not resolve the issue, ssh into the machine and [stop and restart viam-server manually](/operate/reference/viam-server/manage-viam-server/#run-viam-server).
282284

docs/operate/hello-world/tutorial-desk-safari.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,13 @@ Save the config.
645645
{{% /tab %}}
646646
{{< /tabs >}}
647647
648+
{{% /tablestep %}}
649+
{{% tablestep %}}
650+
**Restart module every time you iterate.**
651+
652+
If you make changes to your module code, you must restart your module for the changes to take effect.
653+
Click on the **...** menu near the module and select **Restart**.
654+
648655
{{% /tablestep %}}
649656
{{% tablestep %}}
650657
**Test your game logic.**

docs/operate/modules/control-logic.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -527,6 +527,7 @@ If you are encountering errors, check the **LOGS** tab for more information.
527527
**Iterate.**
528528

529529
If you make changes to your module code, you must restart your module for the changes to take effect.
530+
Click on the **...** menu near the module and select **Restart**.
530531

531532
{{% /tablestep %}}
532533
{{< /table >}}

docs/operate/reference/components/camera/webcam.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -248,13 +248,19 @@ This file contains basic diagnostic and configuration information about your cam
248248
{{% /expand%}}
249249

250250
{{% expand "No visible live video feed" %}}
251-
If you're working on a Linux machine, `ssh` into it, then restart `viam-server` by running:
252251

253-
```sh {class="command-line" data-prompt="$"}
254-
sudo systemctl restart viam-server
255-
```
252+
Restart `viam-server`:
253+
254+
1. Navigate to your machine's page.
255+
1. Select the part status dropdown to the right of your machine's name on the top of the page.
256+
{{<imgproc src="configure/machine-part-info.png" resize="500x" declaredimensions=true alt="machine cloud credentials button on the machine part info dropdown" class="shadow" >}}
257+
1. If you installed `viam-server` with `viam-agent` you will see a **Restart** button. Click it.
258+
Both `viam-server` and `viam-agent` will restart.
259+
260+
If you do not see the **Restart** button, click the **...** menu on the right side of the machine part's card, and select **Restart part**.
261+
If restarting the machine part does not resolve the issue, ssh into the machine and [stop and restart viam-server manually](/operate/reference/viam-server/manage-viam-server/#run-viam-server).
256262
257-
If this doesn't work, you can reboot your machine by running:
263+
If this doesn't work, you can reboot your machine by running the following command on the machine:
258264

259265
```sh {class="command-line" data-prompt="$"}
260266
sudo reboot

docs/operate/reference/viam-server/manage-viam-server.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,6 @@ For example, the following `version_control` configuration will always update to
190190
}
191191
```
192192

193-
To use the new versions of `viam-server` and `viam-agent`, [restart `viam-agent`](/manage/reference/viam-agent/manage-viam-agent/).
194-
When you stop or restart `viam-agent`, the agent also restarts `viam-server`.
195-
196193
{{% /tab %}}
197194
{{% tab name="Manual" %}}
198195

0 commit comments

Comments
 (0)