Skip to content

Commit

Permalink
DOCS-2321: Document fleet dashboard on manage fleet page (#3631)
Browse files Browse the repository at this point in the history
  • Loading branch information
sguequierre authored Oct 30, 2024
1 parent 29cd1b8 commit 380185c
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 11 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/how-tos/manage-fleet/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/cloud/locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@ If you need to create more locations, [contact support](mailto:[email protected])

{{<youtube embed_url="https://www.youtube-nocookie.com/embed/eb7v6dabCGQ">}}

You can access your locations on the Viam app on the **FLEET** tab's [**LOCATIONS** subtab](https://app.viam.com/fleet/locations).

## Add a location

When you create a new organization, Viam automatically creates a new location for you.
You can create additional locations by typing a new location name in the **New Location** field in the left side navigation bar on the [**FLEET** page](https://app.viam.com/robots) and clicking **Add**.
You can create additional locations by typing a new location name in the **New Location** field in the left side navigation bar on the **FLEET** page's [**LOCATIONS** subtab](https://app.viam.com/fleet/locations/) and clicking **Add**.

Click a location's name to display the list of machines associated with that location.

Expand Down
27 changes: 20 additions & 7 deletions docs/how-tos/manage-fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ If you'd like to look at an example, see [Monitor Air Quality with a Fleet of Se
{{% tablestep link="/cloud/locations/" %}}
**2. Create locations**

1. Click **FLEET** in the upper-left corner of the page.
1. Click **FLEET** in the upper-left corner of the page and click **LOCATIONS**.
A new location called `First Location` is automatically generated for you.

Click on the location and use the **...** menu next to edit the location name to what it represents for your use case.
Use the **...** menu to edit the location name to what it represents for your use case.
Then click **Save**.

1. Create additional locations as needed using **Add location** button, on the left of the **FLEET** page.
1. Create additional locations as needed using the **Add location** button, on the left of the **LOCATIONS** page.

{{% /tablestep %}}
{{% tablestep link="/cloud/locations/" %}}
Expand Down Expand Up @@ -130,11 +130,24 @@ You can manage this in the **API Keys** section of the organization settings pag

## Monitoring and debugging

Viam allows you to access each machine, check its logs, check recent changes, and roll back changes if needed.
Viam allows you to view all machines from a dashboard and access each machine, check its logs, check recent changes, and roll back changes if needed.

{{< table >}}
{{% tablestep %}}
**1. Monitor your fleet's parts statuses and synced data**

You can monitor the number of parts online, offline, and awaiting setup from the Viam app's **FLEET** tab's [**DASHBOARD** subtab](https://app.viam.com/fleet/dashboard).
You can also monitor the amount of binary and tabular data your fleet has synced in the last 48 hours on this dashboard.

{{<imgproc src="how-tos/manage-fleet/dashboard.png" resize="500x" declaredimensions=true alt="Fleet dashboard">}}

To view data at the machine part level, including **Location**, **Status**, **Architecture**, and more, go to the **FLEET** tab's [**ALL MACHINES DASHBOARD** subtab](https://app.viam.com/fleet/machines).

{{<imgproc src="how-tos/manage-fleet/all-machines-dashboard.png" resize="500x" declaredimensions=true alt="All machines dashboard">}}

{{% /tablestep %}}
{{% tablestep link="/cloud/machines/#logs" %}}
**1. Monitor your fleet's logs**
**2. Monitor your fleet's logs**

Using the [Viam app](https://app.viam.com), you can monitor the status of each machine from its [**LOGS** tab](/cloud/machines/#logs).

Expand All @@ -144,7 +157,7 @@ You can also access machine logs using [`viam machines logs`](/cli/#machines-ali

{{% /tablestep %}}
{{% tablestep link="/fleet/control/" %}}
**2. Test your machines remotely**
**3. Test your machines remotely**

Using the [Viam app](https://app.viam.com), you can remotely operate machines from the **TEST** pane on the **CONFIGURE** tab or from the [**CONTROL** tab](/fleet/control/).

Expand All @@ -154,7 +167,7 @@ You can also operate machine using the [`viam machines part run`](/cli/#machines

{{% /tablestep %}}
{{% tablestep link="/configure/#configuration-history" %}}
**3. Use configuration version history**
**4. Use configuration version history**

The Viam app keeps a record of your configuration changes, allowing you to revert to earlier configurations if needed.
To see the history of the configuration of a machine part, click on **History** on the **CONFIGURE** tab.
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/control/air-quality-fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ You can choose to manage your fleet of machines differently based on what makes
Create an account and log in.
1. Click the dropdown in the upper-right corner of the **FLEET** page and use the **+** button to create a new organization for your air quality machine company.
Name the organization and click **Create**.
1. Click **FLEET** in the upper-left corner of the page.
1. Click **FLEET** in the upper-left corner of the page and click **LOCATIONS**.
A new location called `First Location` is automatically generated for you.
Rename it so you can use it for Antonia's machines:

Click on the location and use the **...** menu next to edit the location name to `Antonia's Home`, then click **Save**.
Use the **...** menu next to edit the location name to `Antonia's Home`, then click **Save**.

1. Now, create a separate location for RobotsRUs:

On the left side of the **FLEET** page, click the **Add location** button.
On the left side of the **LOCATIONS** page, click the **Add location** button.
Type in `RobotsRUs` and click **Add**.

1. Add sub-locations to the RobotsRUs location to group the machines at each of their offices:
Expand Down

0 comments on commit 380185c

Please sign in to comment.