From 77984cee52e05916571d56592a4acb6f5f6fda65 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 8 Mar 2024 18:21:51 -0800 Subject: [PATCH 1/4] DOCS-1829: Make carousel shortcode and rearrange Build --- docs/build/_index.md | 26 +++--- docs/get-started/_index.md | 114 +------------------------ docs/get-started/viam.md | 4 + docs/platform.md | 114 +------------------------ layouts/partials/scripts.html | 2 +- layouts/shortcodes/board-carousel.html | 114 +++++++++++++++++++++++++ 6 files changed, 137 insertions(+), 237 deletions(-) create mode 100644 layouts/shortcodes/board-carousel.html diff --git a/docs/build/_index.md b/docs/build/_index.md index 17abeb300b..3a19742bbc 100644 --- a/docs/build/_index.md +++ b/docs/build/_index.md @@ -16,40 +16,46 @@ Components drive your hardware, and services provide high-level software functio Viam's APIs are standardized across all models of a given component or service. This means you can test and change hardware without changing code. -{{% alert title="Start building" color="tip" %}} +## Step 1: Install -1. To get started, first [install `viam-server`](/get-started/installation/) on your smart machine's computer. - If you are using a microcontroller instead of a 64-bit computer, you can install a [lightweight version of `viam-server`](/build/micro-rdk/). +To get started, first [install `viam-server`](/get-started/installation/) on your smart machine's computer. +If you are using a microcontroller instead of a 64-bit computer, you can install a [lightweight version of `viam-server`](/build/micro-rdk/). +You can install `viam-server` on your personal computer, or on a single-board computer (SBC) such as one of the following: +

-2. Then pull together the Viam resources you want to use by [configuring your smart machine](/build/configure/). +{{< board-carousel >}} -3. Finally, [program your smart machine](/build/program/) with an SDK in your preferred coding language. +## Step 2: Configure -{{% /alert %}} +Pull together the Viam {{< glossary_tooltip term_id="resource" text="resources" >}} you want to use by [configuring your smart machine](/build/configure/).
-

Components:

+

Components:

{{}}
-

Services:

+

Services:

If a component or service you want to use for your project is not natively supported, see the [modular resource registry](/registry/). -## SDKs +## Step 3: Program -Each category of resource has a standardized API that you can access with an SDK (software development kit) in your preferred programming language. +[Program your smart machine](/build/program/) with an SDK in your preferred coding language. + +Each category of {{< glossary_tooltip term_id="resource" text="resource" >}} has a standardized API that you can access with an SDK (software development kit) in your preferred programming language. For example, you can send the same commands to any kind of motor, using any of the following programming languages: {{}} +

+ {{< cards >}} {{% card link="/build/configure/" %}} {{% card link="/build/program/" %}} diff --git a/docs/get-started/_index.md b/docs/get-started/_index.md index 1cf80a715b..cd02f5a226 100644 --- a/docs/get-started/_index.md +++ b/docs/get-started/_index.md @@ -7,119 +7,7 @@ layout: "empty" empty_node: true --- -
- - - - -
+{{< board-carousel >}}
diff --git a/docs/get-started/viam.md b/docs/get-started/viam.md index d2c2936ade..0866d70469 100644 --- a/docs/get-started/viam.md +++ b/docs/get-started/viam.md @@ -38,6 +38,10 @@ Join the [**Viam community**](https://discord.gg/viam) to collaborate during pla A _smart machine_ in Viam consists of at least one computer, typically a [single-board computer](/get-started/installation/), running `viam-server` and communicating with any hardware connected to it by signaling through digital data pins. Viam supports devices running **any** 64-bit Linux OS or macOS. +Here are some of the boards Viam supports: + +{{< board-carousel >}} +
{{< imgproc src="/viam/board-viam-server.png" alt="A diagram of a single-board computer running viam-server." resize="270x" class="alignleft" style="max-width:270px" >}} diff --git a/docs/platform.md b/docs/platform.md index d6ab1143a9..a3a5bab11f 100644 --- a/docs/platform.md +++ b/docs/platform.md @@ -8,119 +8,7 @@ type: docs Viam is a complete software platform for {{< glossary_tooltip term_id="smart-machine" text="smart machines">}} that runs on Linux and macOS and supports a wide variety of popular systems, including: -
- - - - -
+{{< carousel >}}
Explore the elements of the Viam platform: diff --git a/layouts/partials/scripts.html b/layouts/partials/scripts.html index 77850f730b..183f1c54b7 100644 --- a/layouts/partials/scripts.html +++ b/layouts/partials/scripts.html @@ -1,7 +1,7 @@ {{ $jsCarousel := resources.Get "js/carousel.js" }} {{ $jsCarousel := $jsCarousel | minify }} -{{ if or (eq .Page.Title "Viam Documentation") (eq .Page.Title "Platform") }} +{{ if or (eq .Page.Title "Viam Documentation") (eq .Page.Title "Platform") (eq .Page.Title "Viam in 3 minutes") (eq .Page.Title "Build Your Machine with Flexible Building Blocks") (eq .Page.Title "Get Started") }} {{ end }} diff --git a/layouts/shortcodes/board-carousel.html b/layouts/shortcodes/board-carousel.html new file mode 100644 index 0000000000..fc7060d069 --- /dev/null +++ b/layouts/shortcodes/board-carousel.html @@ -0,0 +1,114 @@ + +
+ + + + +
From 07eb26e8e92c7196c7001cd254ea7cc4915097ce Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 8 Mar 2024 18:23:39 -0800 Subject: [PATCH 2/4] Fix platform shortcode name --- docs/platform.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform.md b/docs/platform.md index a3a5bab11f..57151e988f 100644 --- a/docs/platform.md +++ b/docs/platform.md @@ -8,7 +8,7 @@ type: docs Viam is a complete software platform for {{< glossary_tooltip term_id="smart-machine" text="smart machines">}} that runs on Linux and macOS and supports a wide variety of popular systems, including: -{{< carousel >}} +{{< board-carousel >}}
Explore the elements of the Viam platform: From 0b6e759e8c11c6d7c3d7bcd6a177d94d507599dc Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Mon, 11 Mar 2024 10:54:49 -0700 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> --- docs/build/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build/_index.md b/docs/build/_index.md index 3a19742bbc..60c528e6ff 100644 --- a/docs/build/_index.md +++ b/docs/build/_index.md @@ -27,7 +27,7 @@ You can install `viam-server` on your personal computer, or on a single-board co ## Step 2: Configure -Pull together the Viam {{< glossary_tooltip term_id="resource" text="resources" >}} you want to use by [configuring your smart machine](/build/configure/). +Select the Viam {{< glossary_tooltip term_id="resource" text="resources" >}} you want to use and integrate them by [configuring your smart machine](/build/configure/).
@@ -43,7 +43,7 @@ Pull together the Viam {{< glossary_tooltip term_id="resource" text="resources"
-If a component or service you want to use for your project is not natively supported, see the [modular resource registry](/registry/). +If a component or service you want to use for your project is not natively supported, see whether it is supported as a {{< glossary_tooltip term_id="modular resource" text="modular-resource" >}} in the [registry](/registry/) or build your own modular resource. ## Step 3: Program From 1aef47f4fe6e177f28eb79c34877237600095de8 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Mon, 11 Mar 2024 11:13:57 -0700 Subject: [PATCH 4/4] Fix glossary term --- docs/build/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/_index.md b/docs/build/_index.md index 60c528e6ff..f0fe2a8d5e 100644 --- a/docs/build/_index.md +++ b/docs/build/_index.md @@ -43,7 +43,7 @@ Select the Viam {{< glossary_tooltip term_id="resource" text="resources" >}} you
-If a component or service you want to use for your project is not natively supported, see whether it is supported as a {{< glossary_tooltip term_id="modular resource" text="modular-resource" >}} in the [registry](/registry/) or build your own modular resource. +If a component or service you want to use for your project is not natively supported, see whether it is supported as a {{< glossary_tooltip term_id="modular-resource" text="modular resource" >}} in the [registry](/registry/) or build your own modular resource. ## Step 3: Program