From 3a65aa0346f75004d80c720d4a707bd07a634ff9 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 14 Nov 2023 21:16:18 +0100 Subject: [PATCH] DOCS-1267: Refactor Installation Guide (#2202) --- docs/installation/_index.md | 13 +++++++++---- .../prepare/jetson-agx-orin-setup.md | 16 ++++++++-------- docs/installation/prepare/jetson-nano-setup.md | 16 ++++++++-------- .../prepare/microcontrollers/_index.md | 3 +++ docs/installation/prepare/pumpkin.md | 10 +++++----- docs/installation/prepare/rpi-setup.md | 16 ++++++++-------- docs/installation/prepare/sk-tda4vm.md | 10 +++++----- static/include/install/install-linux-aarch.md | 7 +++++-- static/include/install/install-linux.md | 9 ++++++--- 9 files changed, 57 insertions(+), 43 deletions(-) diff --git a/docs/installation/_index.md b/docs/installation/_index.md index a66214981a..0923b16f6b 100644 --- a/docs/installation/_index.md +++ b/docs/installation/_index.md @@ -73,17 +73,22 @@ If you have a [compatible operating system](/installation/), follow along with t {{% /tab %}} {{% tab name="macOS computer" %}} -`viam-server` is available for macOS users through [Homebrew](https://brew.sh/), and supports both Intel and Apple Silicon macOS computers. +`viam-server` is available for macOS users through Homebrew, and supports both Intel and Apple Silicon macOS computers. To install `viam-server` on a macOS computer: -1. Go to the [Viam app](https://app.viam.com) and [add a new robot](/manage/fleet/robots/#add-a-new-robot). +1. If not installed already, install [Homebrew](https://brew.sh/). + +1. Go to the [Viam app](https://app.viam.com) and add a new robot by providing a name in the **New Robot** field and clicking **Add robot**. If this is your first time using the Viam app, you must create an account first. + ![The 'First Location' page on the Viam app with a new robot name in the New Robot field and the Add robot button next to the field highlighted.](/manage/app-usage/create-robot.png) + 1. On the **Setup** tab, select `Mac` as the **Architecture**. 1. Follow the steps shown on the **Setup** tab to install `viam-server` on your macOS computer. -1. Once `viam-server` is installed and running, return to the **Setup** page on the [Viam app](https://app.viam.com) and wait for confirmation that your computer has successfully connected. +1. Once you have followed the steps on the **Setup** tab, `viam-server` is installed and running. + Return to the **Setup** page on the Viam app and wait for confirmation that your computer has successfully connected. {{% /tab %}} {{< /tabs >}} @@ -99,5 +104,5 @@ To learn how to run, update, or uninstall `viam-server`, see [Manage `viam-serve {{< cards >}} {{% card link="/manage/configuration/" %}} {{% card link="/tutorials/" %}} -{{% card link="/try-viam/" %}} +{{% card link="/program/" %}} {{< /cards >}} diff --git a/docs/installation/prepare/jetson-agx-orin-setup.md b/docs/installation/prepare/jetson-agx-orin-setup.md index c2d65d8518..f59fc17707 100644 --- a/docs/installation/prepare/jetson-agx-orin-setup.md +++ b/docs/installation/prepare/jetson-agx-orin-setup.md @@ -109,6 +109,14 @@ For a Jetson AGX Orin, reference the following: Note that I2C buses do not need to be configured through jetson-io.py. See NVIDIA's documentation on [Configuring the Jetson Expansion Headers](https://docs.nvidia.com/jetson/archives/r35.1/DeveloperGuide/text/HR/ConfiguringTheJetsonExpansionHeaders.html) for more information. +## Next Steps + +{{< cards >}} +{{% card link="/manage/configuration/" %}} +{{% card link="/tutorials/" %}} +{{% card link="/program/" %}} +{{< /cards >}} + ## Troubleshooting - NVIDIA Step 1 - Run through Ubuntu Setup (oem config) @@ -133,11 +141,3 @@ See NVIDIA's documentation on [Configuring the Jetson Expansion Headers](https:/ You can find additional assistance in the [Troubleshooting section](/appendix/troubleshooting/). {{< snippet "social.md" >}} - -## Next Steps - -{{< cards >}} -{{% card link="/manage/configuration/" %}} -{{% card link="/tutorials/" %}} -{{% card link="/try-viam/" %}} -{{< /cards >}} diff --git a/docs/installation/prepare/jetson-nano-setup.md b/docs/installation/prepare/jetson-nano-setup.md index 093eaaf4c1..06395798eb 100644 --- a/docs/installation/prepare/jetson-nano-setup.md +++ b/docs/installation/prepare/jetson-nano-setup.md @@ -97,6 +97,14 @@ For a Jetson Orin Nano, reference the following: Note that I2C buses do not need to be configured through jetson-io.py. See NVIDIA's documentation on [Configuring the Jetson Expansion Headers](https://docs.nvidia.com/jetson/archives/r35.1/DeveloperGuide/text/HR/ConfiguringTheJetsonExpansionHeaders.html) for more information. +## Next Steps + +{{< cards >}} +{{% card link="/manage/configuration/" %}} +{{% card link="/tutorials/" %}} +{{% card link="/program/" %}} +{{< /cards >}} + ## Troubleshooting Make sure the polarity on your barrel jack power supply is matched when powering your robot. @@ -107,11 +115,3 @@ If you do not see an interactive menu after launching jetson-io.py, You can find additional assistance in the [Troubleshooting section](/appendix/troubleshooting/). {{< snippet "social.md" >}} - -## Next Steps - -{{< cards >}} -{{% card link="/manage/configuration/" %}} -{{% card link="/tutorials/" %}} -{{% card link="/try-viam/" %}} -{{< /cards >}} diff --git a/docs/installation/prepare/microcontrollers/_index.md b/docs/installation/prepare/microcontrollers/_index.md index 01fdcf4058..8776e73330 100644 --- a/docs/installation/prepare/microcontrollers/_index.md +++ b/docs/installation/prepare/microcontrollers/_index.md @@ -56,6 +56,9 @@ See [Micro-RDK](/micro-rdk/) to get a list of supported models and instructions Configure your `esp32` board for your robot. {{% /manualcard %}} +{{% card link="/manage/configuration/" %}} +{{% card link="/tutorials/" %}} +{{% card link="/program/" %}} {{< /cards >}} ## Troubleshooting diff --git a/docs/installation/prepare/pumpkin.md b/docs/installation/prepare/pumpkin.md index b476f38e3e..775659fca1 100644 --- a/docs/installation/prepare/pumpkin.md +++ b/docs/installation/prepare/pumpkin.md @@ -245,14 +245,14 @@ Copy and paste the following json object into your board's **Attributes** box. {{% /tab %}} {{< /tabs >}} -## Need assistance? - -{{< snippet "social.md" >}} - ## Next Steps {{< cards >}} {{% card link="/manage/configuration/" %}} {{% card link="/tutorials/" %}} -{{% card link="/try-viam/" %}} +{{% card link="/program/" %}} {{< /cards >}} + +## Need assistance? + +{{< snippet "social.md" >}} diff --git a/docs/installation/prepare/rpi-setup.md b/docs/installation/prepare/rpi-setup.md index af2f763171..0cbaeef73a 100644 --- a/docs/installation/prepare/rpi-setup.md +++ b/docs/installation/prepare/rpi-setup.md @@ -208,6 +208,14 @@ If you are using hardware that requires these protocols, you must enable support {{< readfile "/static/include/install/install-linux.md" >}} +## Next Steps + +{{< cards >}} +{{% card link="/manage/configuration/" %}} +{{% card link="/tutorials/" %}} +{{% card link="/program/" %}} +{{< /cards >}} + ## Troubleshooting ### Write error when imaging Raspberry Pi OS @@ -268,11 +276,3 @@ priority=20 ### Additional troubleshooting You can find additional assistance in the [Troubleshooting section](/appendix/troubleshooting/). - -## Next Steps - -{{< cards >}} -{{% card link="/manage/configuration/" %}} -{{% card link="/tutorials/" %}} -{{% card link="/try-viam/" %}} -{{< /cards >}} diff --git a/docs/installation/prepare/sk-tda4vm.md b/docs/installation/prepare/sk-tda4vm.md index 1427804bda..e32bc191e9 100644 --- a/docs/installation/prepare/sk-tda4vm.md +++ b/docs/installation/prepare/sk-tda4vm.md @@ -103,14 +103,14 @@ From the SSH session on the TDA4VM board: {{< readfile "/static/include/install/install-linux.md" >}} -## Need assistance? - -{{< snippet "social.md" >}} - ## Next Steps {{< cards >}} {{% card link="/manage/configuration/" %}} {{% card link="/tutorials/" %}} -{{% card link="/try-viam/" %}} +{{% card link="/program/" %}} {{< /cards >}} + +## Need assistance? + +{{< snippet "social.md" >}} diff --git a/static/include/install/install-linux-aarch.md b/static/include/install/install-linux-aarch.md index 986f1a92a6..59c811ea21 100644 --- a/static/include/install/install-linux-aarch.md +++ b/static/include/install/install-linux-aarch.md @@ -3,13 +3,16 @@ The AppImage is a single, self-contained binary that runs on 64-bit Linux system To install `viam-server` : -1. Go to the [Viam app](https://app.viam.com) and [add a new robot](/manage/fleet/robots/#add-a-new-robot). +1. Go to the [Viam app](https://app.viam.com) and add a new robot by providing a name in the **New Robot** field and clicking **Add robot**. If this is your first time using the Viam app, you must create an account first. + ![The 'First Location' page on the Viam app with a new robot name in the New Robot field and the Add robot button next to the field highlighted.](/manage/app-usage/create-robot.png) + 1. On the **Setup** tab, select `Linux (Aarch64)`. 1. Follow the steps shown on the **Setup** tab to install `viam-server` on your Linux computer. -1. Once `viam-server` is installed and running, return to the **Setup** page on the [Viam app](https://app.viam.com) and wait for confirmation that your computer has successfully connected. +1. Once you have followed the steps on the **Setup** tab, `viam-server` is installed and running. + Return to the **Setup** page on the Viam app and wait for confirmation that your computer has successfully connected. By default, `viam-server` will start automatically when your system boots, but you can [change this behavior](/installation/manage/) if desired. diff --git a/static/include/install/install-linux.md b/static/include/install/install-linux.md index 81edfaa29b..acfe7b6a28 100644 --- a/static/include/install/install-linux.md +++ b/static/include/install/install-linux.md @@ -1,4 +1,4 @@ -`viam-server` is distributed for Linux as an [AppImage](https://appimage.org/). +`viam-server` is distributed for Linux as an AppImage. The AppImage is a single, self-contained binary that runs on 64-bit Linux systems running the `aarch64` or `x86_64` architectures, with no need to install any dependencies (except for FUSE, which is required by the AppImage format). To install `viam-server` on a Linux computer: @@ -29,14 +29,17 @@ To install `viam-server` on a Linux computer: **Do not** install the `fuse` package (that is, without a version number). `viam-server` requires FUSE version 2 specifically (`libfuse2`). -1. Go to the [Viam app](https://app.viam.com) and [add a new robot](/manage/fleet/robots/#add-a-new-robot). +1. Go to the [Viam app](https://app.viam.com) and add a new robot by providing a name in the **New Robot** field and clicking **Add robot**. If this is your first time using the Viam app, you must create an account first. + ![The 'First Location' page on the Viam app with a new robot name in the New Robot field and the Add robot button next to the field highlighted.](/manage/app-usage/create-robot.png) + 1. On the **Setup** tab, select `Linux (Aarch64)` or `Linux (x86_64)` for the appropriate **Architecture** for your computer. On most Linux operating systems, you can run `uname -m` to confirm your computer's architecture. 1. Follow the steps shown on the **Setup** tab to install `viam-server` on your Linux computer. -2. Once `viam-server` is installed and running, return to the **Setup** page on the [Viam app](https://app.viam.com) and wait for confirmation that your computer has successfully connected. +1. Once you have followed the steps on the **Setup** tab, `viam-server` is installed and running. + Return to the **Setup** page on the Viam app and wait for confirmation that your computer has successfully connected. By default, `viam-server` will start automatically when your system boots, but you can [change this behavior](/installation/manage/) if desired.