Skip to content

Commit

Permalink
Rename use cases to how tos
Browse files Browse the repository at this point in the history
  • Loading branch information
sguequierre committed Aug 15, 2024
1 parent 68eabfd commit 4fee89d
Show file tree
Hide file tree
Showing 58 changed files with 194 additions and 170 deletions.
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
File renamed without changes
4 changes: 2 additions & 2 deletions docs/appendix/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ Viam has added a [sensor-controlled base](/components/base/sensor-controlled/) c

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

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.
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.
You can visualize any data, such as sensor readings, that you have [synced](/services/data/cloud-sync/) to the Viam app from your machine.

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

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.

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

{{% /changelog %}}

Expand Down
4 changes: 2 additions & 2 deletions docs/appendix/glossary/model-namespace-triplet.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Model Namespace Triplet
id: model-namespace-triplet
full_link: /use-cases/create-module/#name-your-new-resource-model
full_link: /how-tos/create-module/#name-your-new-resource-model
short_description: namespace:repo-name:name or rdk:builtin:name
---

{{< glossary_tooltip term_id="model" text="Models" >}} are uniquely namespaced as colon-delimited-triplets.
Modular resource model names have the form `namespace:repo-name:name`.
Built-in model names have the form `rdk:builtin:name`.
See [Name your new resource model](/use-cases/create-module/#name-your-new-resource-model) for more information.
See [Name your new resource model](/how-tos/create-module/#name-your-new-resource-model) for more information.
2 changes: 1 addition & 1 deletion docs/appendix/glossary/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Models are either included with [`viam-server`](/installation/), provided in {{<
All models are uniquely namespaced as colon-delimited-triplets.
Built-in model names have the form `rdk:builtin:name`.
Modular resource model names have the form `namespace:repo-name:name`.
See [Name your new resource model](/use-cases/create-module/#name-your-new-resource-model) for more information.
See [Name your new resource model](/how-tos/create-module/#name-your-new-resource-model) for more information.
2 changes: 1 addition & 1 deletion docs/appendix/glossary/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ short_description: A module provides one or more modular resources, which add re
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.
Modules run alongside `viam-server` as separate process, communicating with `viam-server` over UNIX sockets.

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

For more information see the [modular resource documentation](/registry/).
12 changes: 6 additions & 6 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,8 +336,8 @@ done
| Command option | Description | Positional arguments |
| -------------- | ----------- | -------------------- |
| `export` | Export data in a specified format to a specified location | - |
| `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) | - |
| `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) | - |
| `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) | - |
| `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) | - |
| `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` |
| `dataset remove` | Remove an existing image from a dataset by its file id, or remove a group of images by specifying a filter | `filter` |
| `delete binary` | Delete binary data | - |
Expand Down Expand Up @@ -528,10 +528,10 @@ viam module update
viam module upload --version "1.0.0" --platform "darwin/arm64" packaged-module.tar.gz
```

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.
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.

If you update and release your module as part of a continuous integration (CI) workflow, you can also
[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.
[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.

#### Command options

Expand Down Expand Up @@ -701,12 +701,12 @@ For example, the following represents the configuration of an example `my-module
```

{{% alert title="Important" color="note" %}}
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).
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).
In the example above, the model namespace is set to `acme` to match the owning organization's namespace.
If the two namespaces do not match, the command will return an error.
{{% /alert %}}

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.
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.

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

Expand Down
4 changes: 2 additions & 2 deletions docs/fleet/fragments.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 40
type: "docs"
description: Use fragments to configure many machines at the same time.
tags: ["fleet management", "cloud", "app"]
images: ["/use-cases/one-to-many/new-fragment.png"]
images: ["/how-tos/one-to-many/new-fragment.png"]
aliases:
- /fleet/configure-a-fleet/
---
Expand Down Expand Up @@ -39,7 +39,7 @@ You can add multiple fragments to a single machine, and you can add additional r
Get started with this how-to guide:

{{< cards >}}
{{% card link="/use-cases/one-to-many/" %}}
{{% card link="/how-tos/one-to-many/" %}}
{{< /cards >}}

## Modify the config of a machine that uses a fragment
Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/collect-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,10 @@ Now that you have captured data, you could use this data to train you own Machin

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

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:
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:

{{< cards >}}
{{% card link="/use-cases/" %}}
{{% card link="/how-tos/" %}}
{{% card link="/tutorials/" %}}
{{% card link="/platform/" %}}
{{< /cards >}}
31 changes: 31 additions & 0 deletions docs/how-tos/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "How-to Guides"
linkTitle: "How-to Guides"
weight: 200
type: "docs"
images: ["/registry/module-puzzle-piece.svg"]
description: "Follow instructions for common tasks and workflows."
no_list: true
aliases:
- /use-cases/
---

Click on one of the following guides that provide solutions for common tasks and workflows:

{{< cards >}}
{{% card link="/how-tos/configure/" class="fit-contain" %}}
{{% card link="/how-tos/develop-app/" class="fit-contain" %}}
{{% card link="/how-tos/image-data/" class="fit-contain" %}}
{{% card link="/how-tos/deploy-ml/" class="fit-contain" %}}
{{% card link="/how-tos/collect-sensor-data/" %}}
{{% card link="/how-tos/sensor-data-query-with-third-party-tools/" %}}
{{% card link="/how-tos/sensor-data-query-sdk/" %}}
{{% card link="/how-tos/sensor-data-visualize/" %}}
{{% card link="/how-tos/create-module/" class="fit-contain" %}}
{{% card link="/how-tos/manage-modules/" class="fit-contain" %}}
{{% card link="/how-tos/navigate/" %}}
{{% card link="/how-tos/one-to-many/" class="fit-contain" %}}
{{% card link="/how-tos/manage-fleet/" class="fit-contain" %}}
{{< /cards >}}

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).
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ type: "docs"
images: ["/services/icons/data-capture.svg"]
description: "Gather sensor data, sync it to the cloud, and view it in the Viam app."
modulescript: true
aliases:
- /use-cases/collect-sensor-data/
# SME: Devin Hilly
---

Expand Down Expand Up @@ -113,12 +115,12 @@ Confirm that you are seeing data appear.

## Next steps

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.
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.

{{< cards >}}
{{% card link="/use-cases/sensor-data-query-with-third-party-tools/" %}}
{{% card link="/use-cases/sensor-data-query-sdk/" %}}
{{% card link="/use-cases/sensor-data-visualize/" %}}
{{% card link="/how-tos/sensor-data-query-with-third-party-tools/" %}}
{{% card link="/how-tos/sensor-data-query-sdk/" %}}
{{% card link="/how-tos/sensor-data-visualize/" %}}
{{< /cards >}}

To see sensor data in action, check out this tutorial:
Expand Down
6 changes: 4 additions & 2 deletions docs/use-cases/configure.md → docs/how-tos/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ type: "docs"
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."
images: ["/platform/build.svg", "/services/ml/configure.svg"]
tags: ["components", "configuration"]
aliases:
- /use-cases/configure/
---

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

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/).
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/).

You need to [_configure_](/configure/) your machine so that `viam-server` can interact with its hardware.
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.
Expand Down Expand Up @@ -101,7 +103,7 @@ For more information, see the [configuration documentation](/configure/).
Once you have configured your machine, continue to develop an application:

{{< cards >}}
{{% card link="/use-cases/develop-app/" %}}
{{% card link="/how-tos/develop-app/" %}}
{{< /cards >}}

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

0 comments on commit 4fee89d

Please sign in to comment.