Skip to content

Commit 7ee49f6

Browse files
npentrelnpentrel
committed
Add aliases (#3807)
1 parent 953fe67 commit 7ee49f6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1703
-9
lines changed

‎docs/_index.md

+8
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ images: ["/general/understand.png"]
1717
noedit: true
1818
date: "2024-09-17"
1919
updated: "2024-10-11"
20+
aliases:
21+
- "/getting-started/"
22+
- "/getting-started/high-level-overview"
23+
- "/product-overviews/"
24+
- "/viam/"
25+
- "/viam/app.viam.com/"
26+
- "/get-started/"
27+
- "/platform/"
2028
---
2129

2230
<!-- Need to use upside down logic because using Subsequent-sibling combinator -->

‎docs/data-ai/ai/create-dataset.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ weight: 10
55
layout: "docs"
66
type: "docs"
77
description: "Create a dataset to train a machine learning model."
8+
aliases:
9+
- /fleet/dataset/
10+
- /manage/data/label/
11+
- /manage/data/dataset/
12+
- /data/dataset/
813
---
914

1015
To ensure a machine learning model you create performs well, you need to train it on a variety of images that cover the range of things your machine should be able to recognize.

‎docs/data-ai/capture-data/capture-sync.md

+14
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,20 @@ aliases:
1818
- /services/data/capture-sync/
1919
- /how-tos/sensor-data/
2020
- /services/data/
21+
- fleet/data-management/
22+
- /manage/data-management/
23+
- /services/data-management/
24+
- /manage/data/
25+
- "/data-management/"
26+
- "/data-management/"
27+
- "/services/data/"
28+
- "/data/"
29+
- /manage/data/export/
30+
- /data/export/
31+
- /services/data/export/
32+
- /manage/data/view/
33+
- /data/view/
34+
- /services/data/view/
2135
---
2236

2337
You can use data management service to capture and sync data from your machine to the cloud.

‎docs/dev/reference/apis/_index.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ aliases:
1010
- /program/sdks/
1111
- /program/apis/
1212
- /build/program/apis/
13+
- /appendix/apis/
1314
no_list: true
1415
date: "2024-10-01"
1516
# updated: "" # When the content was last entirely checked

‎docs/dev/reference/apis/billing-client.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags: ["cloud", "sdk", "viam-server", "networking", "apis", "robot api"]
88
aliases:
99
- /program/apis/billing-client/
1010
- /build/program/apis/billing-client/
11+
- /appendix/apis/billing-client/
1112
date: "2024-09-14"
1213
# updated: "" # When the content was last entirely checked
1314
---

‎docs/dev/reference/apis/robot.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags: ["robot state", "sdk", "apis", "robot api"]
88
aliases:
99
- /program/apis/robot/
1010
- /build/program/apis/robot/
11+
- /appendix/apis/robot/
1112
date: "2022-01-01"
1213
# updated: "" # When the content was last entirely checked
1314
---

‎docs/dev/reference/apis/services/SLAM.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: "Give commands to get a machine's position within a map."
88
icon: true
99
images: ["/services/icons/slam.svg"]
1010
date: "2022-01-01"
11+
aliases:
12+
- /appendix/apis/services/slam/
1113
# updated: "" # When the content was last entirely checked
1214
---
1315

‎docs/dev/reference/apis/services/base-rc.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: "Give commands to get a list of inputs from the controller that are
88
icon: true
99
images: ["/services/icons/base-rc.svg"]
1010
date: "2022-01-01"
11+
aliases:
12+
- /appendix/apis/services/base-rc/
1113
# updated: "" # When the content was last entirely checked
1214
---
1315

‎docs/dev/reference/apis/services/generic.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: "Give commands to your generic components for running model-specifi
88
icon: true
99
images: ["/icons/components/generic.svg"]
1010
date: "2022-01-01"
11+
aliases:
12+
- /appendix/apis/services/generic/
1113
# updated: "" # When the content was last entirely checked
1214
---
1315

‎docs/dev/reference/apis/services/navigation.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: "Give commands to define waypoints and move your machine along thos
88
icon: true
99
images: ["/services/icons/navigation.svg"]
1010
date: "2022-01-01"
11+
aliases:
12+
- /appendix/apis/services/navigation/
1113
# updated: "" # When the content was last entirely checked
1214
---
1315

‎docs/dev/reference/apis/services/vision.md

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ icon: true
1717
images: ["/services/icons/vision.svg"]
1818
tags: ["vision", "computer vision", "CV", "services"]
1919
date: "2022-01-01"
20+
aliases:
21+
- /appendix/apis/services/vision/
2022
# updated: "" # When the content was last entirely checked
2123
---
2224

‎docs/dev/reference/apis/sessions.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ tags:
1919
aliases:
2020
- /program/apis/sessions/
2121
- /build/program/apis/sessions/
22+
- /appendix/apis/sessions/
2223
date: "2022-01-01"
2324
# updated: "" # When the content was last entirely checked
2425
---

‎docs/dev/reference/changelog.md

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ aliases:
3030
- "/components/sensor/bme280/"
3131
- "/components/sensor/ds18b20/"
3232
- "/components/sensor/sensirion-sht3xd/"
33+
- /appendix/changelog/
3334
layout: "changelog"
3435
outputs:
3536
- rss

‎docs/dev/reference/sdks/python/python-venv.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ tags:
99
["client", "sdk", "application", "sdk", "fleet", "program", "python", "venv"]
1010
aliases:
1111
- /program/python-venv/
12+
- /sdks/python/python-venv/
1213
date: "2022-01-01"
1314
# updated: "" # When the content was last entirely checked
1415
---

‎docs/dev/reference/sdks/use-extra-params.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ tags: ["sdk", "extra", "extend"]
99
aliases:
1010
- /program/sdks/use-extra-params
1111
- /program/use-extra-params/
12+
- /sdks/use-extra-params/
1213
date: "2022-01-01"
1314
# updated: "" # When the content was last entirely checked
1415
---

‎docs/dev/reference/try-viam/_index.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "Try Viam"
3+
linkTitle: "Try Viam"
4+
childTitleEndOverwrite: "Try Viam"
5+
weight: 85
6+
type: "docs"
7+
description: "Try Viam by taking over a Viam Rover in our robotics lab."
8+
videos: ["/appendix/try-viam/rover.webm", "/appendix/try-viam/rover.mp4"]
9+
videoAlt: "Rover reservation management page"
10+
images: ["/appendix/try-viam/rover.gif"]
11+
no_list: true
12+
aliases:
13+
- "/getting-started/try-viam/"
14+
- "/tutorials/viam-rover/"
15+
- /get-started/try-viam/tutorials/
16+
- "/appendix/try-viam/tutorials/"
17+
- "/try-viam/"
18+
- "/get-started/try-viam/"
19+
- "/appendix/try-viam-faq/"
20+
- "/try-viam/faq/"
21+
- "get-started/try-viam/faq/"
22+
- /appendix/try-viam/
23+
date: "2022-01-01"
24+
# updated: "" # When the content was last entirely checked
25+
---
26+
27+
Viam is a general {{< glossary_tooltip term_id="smart-machine" text="smart machine">}} platform that can run on any hardware.
28+
The easiest way to try Viam is to [rent and remotely configure and control a Viam Rover](https://app.viam.com/try) located on-site at Viam in New York:
29+
30+
<table>
31+
<tr>
32+
<th>{{<imgproc src="/appendix/try-viam/try-viam-1.svg" class="fill alignright" style="width: 300px" declaredimensions=true alt="ALT">}}
33+
<b>1. Click on TRY in Viam</b>
34+
<p>Log into the Viam app and go to the <a href="https://app.viam.com/try">TRY tab</a>. Don’t have a Viam account? Follow the <a href="/cloud/account/#create-account-and-log-in">instructions to sign up</a> for an account.</p>
35+
</th>
36+
</tr>
37+
<tr>
38+
<td>{{<imgproc src="/appendix/try-viam/try-viam-2.svg" class="fill alignleft" style="width: 300px" declaredimensions=true alt="ALT">}}
39+
<b>2. Reserve your slot</b>
40+
<p>If no one’s using a Viam Rover, you’ll take over immediately.
41+
Otherwise, you’ll see an estimated time for the next slot, and we’ll send you an email when it’s your turn.
42+
See <a href="/appendix/try-viam/reserve-a-rover/">detailed instructions</a>.</p>
43+
</td>
44+
</tr>
45+
<tr>
46+
<td>{{<imgproc src="/appendix/try-viam/try-viam-3.svg" class="fill alignright" style="width: 300px" declaredimensions=true alt="ALT">}}
47+
<b>3. Get started with Viam</b>
48+
<p>Try a Viam Rover in our robotics lab. <a href="/cloud/machines/#control">Drive</a> or <a href="/tutorials/control/drive-rover/">program</a> the rover to see how you can build a machine with Viam.</a></p>
49+
</td>
50+
</tr>
51+
</table>
52+
53+
## Next steps
54+
55+
{{< cards >}}
56+
{{% card link="/tutorials/control/drive-rover/" %}}
57+
{{% card link="/dev/reference/try-viam/rover-resources/" %}}
58+
{{< /cards >}}

‎docs/dev/reference/try-viam/reserve-a-rover.md

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
title: "Reserve a Viam Rover"
3+
linkTitle: "Reserve a Viam Rover"
4+
weight: 10
5+
type: "docs"
6+
description: "Reserve a Viam Rover located on-site at Viam in NYC."
7+
images: ["/appendix/try-viam/try-viam-reserve-preview.png"]
8+
imageAlt: "Rover reservation page"
9+
tags: ["try viam", "app"]
10+
aliases:
11+
- "/try-viam/reserve-a-rover/"
12+
- "/get-started/try-viam/reserve-a-rover/"
13+
toc_hide: true
14+
date: "2022-01-01"
15+
# updated: "" # When the content was last entirely checked
16+
---
17+
18+
_Try Viam_ is a way to try out the Viam platform without setting up any hardware yourself.
19+
You can take over a Viam Rover in our robotics lab to play around!
20+
21+
Watch this tutorial video for a walkthrough of Try Viam, including [how to reserve a Viam Rover](#using-the-reservation-system), [navigate the Viam platform](/fleet/), and [drive the rover](/components/base/wheeled/#test-the-base):
22+
23+
{{<youtube embed_url="https://www.youtube-nocookie.com/embed/YYpZ9CVDwMU" max-width="600px">}}
24+
25+
## Using the reservation system
26+
27+
### Create a reservation
28+
29+
{{< readfile "/static/include/try-viam/create-a-reservation.md" >}}
30+
31+
### Access your rover rental
32+
33+
Once your reservation starts and the system has configured your rover, click **TRY MY ROVER** from the [**TRY VIAM** page](https://app.viam.com/try) or, if you were queuing, click **Take Me to My Rover** in the confirmation email.
34+
35+
{{<gif webm_src="/appendix/try-viam/rover-reservation.webm" mp4_src="/appendix/try-viam/rover-reservation.mp4" alt="Rover reservation management page" max-width="1000px">}}
36+
37+
{{<imgproc src="appendix/try-viam/navigation-bar.png" resize="800x" alt="Navigation bar of the Viam app with the Viam Rover time remaining indicator.">}}
38+
39+
### Limitations
40+
41+
When using a rented Viam rover, adding [modules](/registry/) is disabled for security purposes.
42+
43+
### Extend your reservation
44+
45+
{{< readfile "/static/include/try-viam/extend-a-reservation.md" >}}
46+
47+
### Cancel my reservation
48+
49+
{{< readfile "/static/include/try-viam/cancel-a-reservation.md" >}}
50+
51+
## Next steps
52+
53+
{{< cards >}}
54+
{{% card link="/tutorials/control/drive-rover/" %}}
55+
{{< /cards >}}
56+
57+
## FAQ
58+
59+
Try Viam allows you to try the Viam platform without setting up any hardware yourself.
60+
You can take over and play around with a Viam Rover in our robotics lab from anywhere in the world!
61+
62+
### How do I make a reservation to take over a Viam Rover?
63+
64+
{{< readfile "/static/include/try-viam/create-a-reservation.md" >}}
65+
66+
### My machine had an error, a system crash, or is physically stuck
67+
68+
1. Please notify Viam support on [our Community Discord](https://discord.gg/viam).
69+
2. Use the **Add Viam Support** button on your machine's Location page to give Viam Support access to your _location_.
70+
Refer to [Managing Locations and sub-locations](/cloud/locations/).
71+
72+
### Can I extend my time?
73+
74+
Sure!
75+
76+
{{< readfile "/static/include/try-viam/extend-a-reservation.md" >}}
77+
78+
### Can I cancel my reservation/session?
79+
80+
Yes.
81+
82+
{{< readfile "/static/include/try-viam/cancel-a-reservation.md" >}}
83+
84+
### How can I reuse my borrowed rover?
85+
86+
After using Try Viam, your machine config stays in your Viam account.
87+
You can access your machine page, write code to control it, and modify its config after your reservation time ends.
88+
89+
When you next borrow a rover you can choose to configure it with a previous rover configuration from your account or create a new rover with the standard starting config.
90+
91+
{{< alert title="Tip" color="tip" >}}
92+
You can also reuse your code for the rover for other machines that you configure with Viam in the future.
93+
{{< /alert >}}
94+
95+
### What happens to my borrowed rover after the rental session?
96+
97+
1. On session expiration, Viam removes the "live" status from the machine.
98+
2. Viam then removes your config from the physical machine in preparation for its next rental.
99+
3. The Rover Rental Location and the final config of all previous rental rovers remain visible to your organization.
100+
You can continue modifying the configurations as desired.
101+
102+
### I accidentally deleted my machine
103+
104+
Unfortunately, there is no recovery path for a deleted machine.
105+
If you delete your machine and have a current reservation, click **Cancel Reservation** and then request a new reservation.
106+
107+
### Can I rename my machine or change the location?
108+
109+
You can rename your machine or change the location.
110+
If you change the location, you must refresh the page.
111+
112+
### Which organization does this machine e belong to?
113+
114+
Your machine belongs to the [organization](/cloud/organizations/) you were in when you made the request.
115+
116+
### Can I share this Location with a friend to work on the machine together?
117+
118+
Sure, you can [invite other users to your organization](/cloud/locations/) to collaborate on your machine.
119+
As members of your organization, those users have full control of your machine.
120+
Another collaboration option is to use screen sharing in a Zoom or Webex session.
121+
122+
### How many active rentals can I have?
123+
124+
You can only borrow one rover at a time.
125+
You cannot join the queue for another reservation while you have an active rental session.
126+
If you would like to, you can [extend your reservation](/appendix/try-viam/reserve-a-rover/#can-i-extend-my-time).
127+
128+
### I loved my experience - can I play around more?
129+
130+
Yes! You can borrow the rover as many times as you’d like.
131+
Here are some tutorials which you can follow:
132+
133+
- [Drive with the Viam SDK](/tutorials/control/drive-rover/)
134+
135+
If you want to get your own Viam Rover, [you can](https://viam.com/resources/rover).
136+
137+
### Why can't I use the rover's microphone?
138+
139+
For security reasons, Viam has disabled the microphone on rover rentals.
140+
The microphone on [Viam Rovers shipped to you](/dev/reference/try-viam/rover-resources/) functions normally.
141+
142+
{{< snippet "social.md" >}}

0 commit comments

Comments
 (0)