Skip to content

Commit 6be55f3

Browse files
authored
DOCS-2772: Rename use cases to how tos (#3258)
1 parent db7c204 commit 6be55f3

Some content is hidden

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

60 files changed

+205
-180
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/_index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -30,42 +30,42 @@ carouselscript: true
3030
</a>
3131
</div>
3232
<div class="col hover-card link-with-icon">
33-
<a href="use-cases/configure/" class="noanchor"><div>
33+
<a href="how-tos/configure/" class="noanchor"><div>
3434
<picture><img src="icons/build.svg" alt="Build" loading="lazy"></picture>
3535
<p>Build simple smart machines</p></div>
3636
</a>
3737
</div>
3838
<div class="col hover-card link-with-icon">
39-
<a href="use-cases/image-data/" class="noanchor"><div>
39+
<a href="how-tos/image-data/" class="noanchor"><div>
4040
<picture><img src="icons/data.svg" alt="Data Management" loading="lazy"></picture>
4141
<p>Capture and sync image data</p></div>
4242
</a>
4343
</div>
4444
<div class="col hover-card link-with-icon">
45-
<a href="use-cases/collect-sensor-data/" class="noanchor"><div>
45+
<a href="how-tos/collect-sensor-data/" class="noanchor"><div>
4646
<picture><img src="icons/data-analytics.svg" alt="Data Analytics" loading="lazy"></picture>
4747
<p>Capture and sync sensor data</p></div>
4848
</a>
4949
</div>
5050
<div class="col hover-card link-with-icon">
51-
<a href="use-cases/create-module/" class="noanchor"><div>
51+
<a href="how-tos/create-module/" class="noanchor"><div>
5252
<picture><img src="icons/code-deployment.svg" alt="Code deployment" loading="lazy"></picture>
5353
<p>Manage and deploy code versions</p></div>
5454
</a>
5555
</div>
5656
<div class="col hover-card link-with-icon">
57-
<a href="use-cases/deploy-ml/" class="noanchor"><div>
57+
<a href="how-tos/deploy-ml/" class="noanchor"><div>
5858
<picture><img src="icons/ml.svg" alt="Machine Learning" loading="lazy"></picture>
5959
<p>Train and deploy classification models</p></div>
6060
</a>
6161
</div>
6262
<div class="col hover-card link-with-icon">
63-
<a href="use-cases/navigate/" class="noanchor"><div>
63+
<a href="how-tos/navigate/" class="noanchor"><div>
6464
<picture><img src="icons/mobility.svg" alt="Mobility" loading="lazy"></picture>
6565
<p>Teleoperate and navigate with rovers</p></div></a>
6666
</div>
6767
<div class="col hover-card link-with-icon">
68-
<a href="use-cases/manage-fleet/" class="noanchor"><div>
68+
<a href="how-tos/manage-fleet/" class="noanchor"><div>
6969
<picture><img src="icons/fleet.svg" alt="Fleet" loading="lazy"></picture>
7070
<p>Manage a fleet of machines</p></div></a>
7171
</div>
@@ -88,7 +88,7 @@ carouselscript: true
8888
<div class="cards max-page use-cases">
8989
<div class="row">
9090
<div class="col hover-card link-with-icon">
91-
<a href="use-cases/" class="noanchor"><div>
91+
<a href="how-tos/" class="noanchor"><div>
9292
<picture><img src="icons/rover.svg" alt="Rover" loading="lazy"></picture>
9393
<p>How-to Guides</p></div>
9494
</a>

docs/appendix/changelog.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Viam has added a [sensor-controlled base](/components/base/sensor-controlled/) c
196196

197197
{{% changelog date="2024-01-31" color="added" title="Visualize captured data" %}}
198198

199-
You can now [visualize your data](/use-cases/sensor-data-visualize/) using many popular third-party visualization tools, including Grafana, Tableau, Google’s Looker Studio, and more.
199+
You can now [visualize your data](/how-tos/sensor-data-visualize/) using many popular third-party visualization tools, including Grafana, Tableau, Google’s Looker Studio, and more.
200200
You can visualize any data, such as sensor readings, that you have [synced](/services/data/cloud-sync/) to the Viam app from your machine.
201201

202202
See [Visualize data with Grafana](/tutorials/services/visualize-data-grafana/) for a full walkthrough focused on Grafana specifically.
@@ -242,7 +242,7 @@ Location secrets, the previous method of authentication, is deprecated and will
242242

243243
Once you have added the data management service and synced data, such as sensor readings, to the Viam app, you can now run queries against both captured data as well as its metadata using either SQL or MQL.
244244

245-
For more information, see [Query Data with SQL or MQL](/use-cases/sensor-data-query-with-third-party-tools/).
245+
For more information, see [Query Data with SQL or MQL](/how-tos/sensor-data-query-with-third-party-tools/).
246246

247247
{{% /changelog %}}
248248

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Model Namespace Triplet
33
id: model-namespace-triplet
4-
full_link: /use-cases/create-module/#name-your-new-resource-model
4+
full_link: /how-tos/create-module/#name-your-new-resource-model
55
short_description: namespace:repo-name:name or rdk:builtin:name
66
---
77

88
{{< glossary_tooltip term_id="model" text="Models" >}} are uniquely namespaced as colon-delimited-triplets.
99
Modular resource model names have the form `namespace:repo-name:name`.
1010
Built-in model names have the form `rdk:builtin:name`.
11-
See [Name your new resource model](/use-cases/create-module/#name-your-new-resource-model) for more information.
11+
See [Name your new resource model](/how-tos/create-module/#name-your-new-resource-model) for more information.

docs/appendix/glossary/model.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Models are either included with [`viam-server`](/installation/), provided in {{<
1616
All models are uniquely namespaced as colon-delimited-triplets.
1717
Built-in model names have the form `rdk:builtin:name`.
1818
Modular resource model names have the form `namespace:repo-name:name`.
19-
See [Name your new resource model](/use-cases/create-module/#name-your-new-resource-model) for more information.
19+
See [Name your new resource model](/how-tos/create-module/#name-your-new-resource-model) for more information.

docs/appendix/glossary/module.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ short_description: A module provides one or more modular resources, which add re
88
A _module_ provides one or more {{< glossary_tooltip term_id="modular-resource" text="modular resources" >}}, which add {{< glossary_tooltip term_id="resource" text="resource" >}} {{< glossary_tooltip term_id="type" text="types" >}} or {{< glossary_tooltip term_id="model" text="models" >}} that are not built into Viam.
99
Modules run alongside `viam-server` as separate process, communicating with `viam-server` over UNIX sockets.
1010

11-
You can [create your own module](/use-cases/create-module/) or [add existing modules from the Viam registry](/registry/configure/).
11+
You can [create your own module](/how-tos/create-module/) or [add existing modules from the Viam registry](/registry/configure/).
1212

1313
For more information see the [modular resource documentation](/registry/).

docs/cli.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -336,8 +336,8 @@ done
336336
| Command option | Description | Positional arguments |
337337
| -------------- | ----------- | -------------------- |
338338
| `export` | Export data in a specified format to a specified location | - |
339-
| `database configure` | Create a new database user for the Viam organization's MongoDB Atlas Data Federation instance, or change the password of an existing user. See [Configure data query](/use-cases/sensor-data-query-with-third-party-tools/#configure-data-query) | - |
340-
| `database hostname` | Get the MongoDB Atlas Data Federation instance hostname and connection URI. See [Configure data query](/use-cases/sensor-data-query-with-third-party-tools/#configure-data-query) | - |
339+
| `database configure` | Create a new database user for the Viam organization's MongoDB Atlas Data Federation instance, or change the password of an existing user. See [Configure data query](/how-tos/sensor-data-query-with-third-party-tools/#configure-data-query) | - |
340+
| `database hostname` | Get the MongoDB Atlas Data Federation instance hostname and connection URI. See [Configure data query](/how-tos/sensor-data-query-with-third-party-tools/#configure-data-query) | - |
341341
| `dataset add` | Add a new image to an existing dataset by its file id, or add a group of images by specifying a filter | `filter` |
342342
| `dataset remove` | Remove an existing image from a dataset by its file id, or remove a group of images by specifying a filter | `filter` |
343343
| `delete binary` | Delete binary data | - |
@@ -528,10 +528,10 @@ viam module update
528528
viam module upload --version "1.0.0" --platform "darwin/arm64" packaged-module.tar.gz
529529
```
530530

531-
See [Upload a custom module](/use-cases/create-module/#upload-your-module-to-the-modular-resource-registry) and [Update an existing module](/use-cases/manage-modules/#update-an-existing-module) for a detailed walkthrough of the `viam module` commands.
531+
See [Upload a custom module](/how-tos/create-module/#upload-your-module-to-the-modular-resource-registry) and [Update an existing module](/how-tos/manage-modules/#update-an-existing-module) for a detailed walkthrough of the `viam module` commands.
532532

533533
If you update and release your module as part of a continuous integration (CI) workflow, you can also
534-
[automatically upload new versions of your module on release](/use-cases/manage-modules/#update-an-existing-module-using-a-github-action) using a GitHub Action.
534+
[automatically upload new versions of your module on release](/how-tos/manage-modules/#update-an-existing-module-using-a-github-action) using a GitHub Action.
535535

536536
#### Command options
537537

@@ -701,12 +701,12 @@ For example, the following represents the configuration of an example `my-module
701701
```
702702

703703
{{% alert title="Important" color="note" %}}
704-
If you are publishing a public module (`"visibility": "public"`), the [namespace of your model](/use-cases/create-module/#name-your-new-resource-model) must match the [namespace of your organization](/cloud/organizations/#create-a-namespace-for-your-organization).
704+
If you are publishing a public module (`"visibility": "public"`), the [namespace of your model](/how-tos/create-module/#name-your-new-resource-model) must match the [namespace of your organization](/cloud/organizations/#create-a-namespace-for-your-organization).
705705
In the example above, the model namespace is set to `acme` to match the owning organization's namespace.
706706
If the two namespaces do not match, the command will return an error.
707707
{{% /alert %}}
708708

709-
See [Upload a custom module](/use-cases/create-module/#upload-your-module-to-the-modular-resource-registry) and [Update an existing module](/use-cases/manage-modules/#update-an-existing-module) for a detailed walkthrough of the `viam module` commands.
709+
See [Upload a custom module](/how-tos/create-module/#upload-your-module-to-the-modular-resource-registry) and [Update an existing module](/how-tos/manage-modules/#update-an-existing-module) for a detailed walkthrough of the `viam module` commands.
710710

711711
See [Modular resources](/registry/) for a conceptual overview of modules and the modular resource system at Viam.
712712

docs/fleet/fragments.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 40
55
type: "docs"
66
description: Use fragments to configure many machines at the same time.
77
tags: ["fleet management", "cloud", "app"]
8-
images: ["/use-cases/one-to-many/new-fragment.png"]
8+
images: ["/how-tos/one-to-many/new-fragment.png"]
99
aliases:
1010
- /fleet/configure-a-fleet/
1111
---
@@ -39,7 +39,7 @@ You can add multiple fragments to a single machine, and you can add additional r
3939
Get started with this how-to guide:
4040

4141
{{< cards >}}
42-
{{% card link="/use-cases/one-to-many/" %}}
42+
{{% card link="/how-tos/one-to-many/" %}}
4343
{{< /cards >}}
4444

4545
## Modify the config of a machine that uses a fragment

docs/get-started/collect-data.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -246,10 +246,10 @@ Now that you have captured data, you could use this data to train you own Machin
246246

247247
This concludes our guided path for getting to know the Viam platform.
248248

249-
To learn more about the viam platform, dive into the [How-to Guides](/use-cases/) which provide instructions for common tasks and workflows, check out [Tutorials](/tutorials/) for projects, or learn more in the [Platform Reference](/platform/) documentation:
249+
To learn more about the viam platform, dive into the [How-to Guides](/how-tos/) which provide instructions for common tasks and workflows, check out [Tutorials](/tutorials/) for projects, or learn more in the [Platform Reference](/platform/) documentation:
250250

251251
{{< cards >}}
252-
{{% card link="/use-cases/" %}}
252+
{{% card link="/how-tos/" %}}
253253
{{% card link="/tutorials/" %}}
254254
{{% card link="/platform/" %}}
255255
{{< /cards >}}

docs/how-tos/_index.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "How-to Guides"
3+
linkTitle: "How-to Guides"
4+
weight: 200
5+
type: "docs"
6+
images: ["/registry/module-puzzle-piece.svg"]
7+
description: "Follow instructions for common tasks and workflows."
8+
no_list: true
9+
aliases:
10+
- /use-cases/
11+
---
12+
13+
Click on one of the following guides that provide solutions for common tasks and workflows:
14+
15+
{{< cards >}}
16+
{{% card link="/how-tos/configure/" class="fit-contain" %}}
17+
{{% card link="/how-tos/develop-app/" class="fit-contain" %}}
18+
{{% card link="/how-tos/image-data/" class="fit-contain" %}}
19+
{{% card link="/how-tos/deploy-ml/" class="fit-contain" %}}
20+
{{% card link="/how-tos/collect-sensor-data/" %}}
21+
{{% card link="/how-tos/sensor-data-query-with-third-party-tools/" %}}
22+
{{% card link="/how-tos/sensor-data-query-sdk/" %}}
23+
{{% card link="/how-tos/sensor-data-visualize/" %}}
24+
{{% card link="/how-tos/create-module/" class="fit-contain" %}}
25+
{{% card link="/how-tos/manage-modules/" class="fit-contain" %}}
26+
{{% card link="/how-tos/navigate/" %}}
27+
{{% card link="/how-tos/one-to-many/" class="fit-contain" %}}
28+
{{% card link="/how-tos/manage-fleet/" class="fit-contain" %}}
29+
{{< /cards >}}
30+
31+
If you're looking for examples of how Viam is being used in the world, have a look at [customer stories](https://www.viam.com/customers), follow our [step-by-step tutorials](/tutorials/), or browse our [blog posts](https://www.viam.com/blog?categories=Tutorials).

docs/use-cases/collect-sensor-data.md docs/how-tos/collect-sensor-data.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ type: "docs"
66
images: ["/services/icons/data-capture.svg"]
77
description: "Gather sensor data, sync it to the cloud, and view it in the Viam app."
88
modulescript: true
9+
aliases:
10+
- /use-cases/collect-sensor-data/
911
# SME: Devin Hilly
1012
---
1113

@@ -113,12 +115,12 @@ Confirm that you are seeing data appear.
113115

114116
## Next steps
115117

116-
Now that you have collected sensor data, you can [query it](/use-cases/sensor-data-query-with-third-party-tools/), [access it programmatically](/use-cases/sensor-data-query-sdk/) or [visualize it](/use-cases/sensor-data-visualize/) with third-party tools.
118+
Now that you have collected sensor data, you can [query it](/how-tos/sensor-data-query-with-third-party-tools/), [access it programmatically](/how-tos/sensor-data-query-sdk/) or [visualize it](/how-tos/sensor-data-visualize/) with third-party tools.
117119

118120
{{< cards >}}
119-
{{% card link="/use-cases/sensor-data-query-with-third-party-tools/" %}}
120-
{{% card link="/use-cases/sensor-data-query-sdk/" %}}
121-
{{% card link="/use-cases/sensor-data-visualize/" %}}
121+
{{% card link="/how-tos/sensor-data-query-with-third-party-tools/" %}}
122+
{{% card link="/how-tos/sensor-data-query-sdk/" %}}
123+
{{% card link="/how-tos/sensor-data-visualize/" %}}
122124
{{< /cards >}}
123125

124126
To see sensor data in action, check out this tutorial:

docs/use-cases/configure.md docs/how-tos/configure.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ type: "docs"
66
description: "Build a simple smart machine in a few steps using Viam's modular system of components and services without writing much or any code."
77
images: ["/platform/build.svg", "/services/ml/configure.svg"]
88
tags: ["components", "configuration"]
9+
aliases:
10+
- /use-cases/configure/
11+
- use-cases/configure/
912
---
1013

1114
You can get a smart machine running with Viam in just a few steps.
@@ -58,7 +61,7 @@ For each component that makes up your machine:
5861
3. Click on the **Test** area of the configuration panel to test your component.
5962
4. If any problems occur check the [logs](/cloud/machines/#logs) or review or roll back the [configuration history](/cloud/machines/#configure).
6063

61-
If a component you want to use for your project is not natively supported, you can [build your own modular resource](/use-cases/create-module/).
64+
If a component you want to use for your project is not natively supported, you can [build your own modular resource](/how-tos/create-module/).
6265

6366
You need to [_configure_](/configure/) your machine so that `viam-server` can interact with its hardware.
6467
Use the configuration builder tool in the Viam app to create a file that describes what hardware you are using and how it is connected.
@@ -101,7 +104,7 @@ For more information, see the [configuration documentation](/configure/).
101104
Once you have configured your machine, continue to develop an application:
102105

103106
{{< cards >}}
104-
{{% card link="/use-cases/develop-app/" %}}
107+
{{% card link="/how-tos/develop-app/" %}}
105108
{{< /cards >}}
106109

107110
To see full sample projects, that configure and control machines, check out these tutorials:

0 commit comments

Comments
 (0)