From 8e9eb62ee0a4a41944f369ca95673e479274b30e Mon Sep 17 00:00:00 2001
From: Mike Szczys <mike@golioth.io>
Date: Wed, 3 Jan 2024 16:24:35 -0600
Subject: [PATCH] partials: pass workspace directory as property

Partials are used on both Zephyr and NCS setup but the workspace directory is
different between the two. This commit adds a property to ensure the correct
workspace directory name for the install.

Signed-off-by: Mike Szczys <mike@golioth.io>
---
 docs/partials-common/setup-west-nrf91.md     |  6 +++---
 docs/partials-common/setup-zephyr-unix.md    | 18 +++++++++---------
 docs/partials-common/setup-zephyr-windows.md |  4 ++--
 docs/partials-common/setup-zephyr.md         |  6 +++---
 4 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/docs/partials-common/setup-west-nrf91.md b/docs/partials-common/setup-west-nrf91.md
index 62cc1331..6cde8d1f 100644
--- a/docs/partials-common/setup-west-nrf91.md
+++ b/docs/partials-common/setup-west-nrf91.md
@@ -28,7 +28,7 @@ sudo apt install --no-install-recommends git cmake ninja-build gperf \
   make gcc gcc-multilib g++-multilib libsdl2-dev
 ```
 
-<SetupZephyrUnix />
+<SetupZephyrUnix workspace_directory="golioth-ncs-workspace" />
 
 </TabItem>
 <TabItem value="macos">
@@ -39,14 +39,14 @@ Start by installing dependencies with `brew`:
 brew install cmake ninja gperf python3 ccache qemu dtc
 ```
 
-<SetupZephyrUnix />
+<SetupZephyrUnix workspace_directory="golioth-ncs-workspace" />
 
 </TabItem>
 <TabItem value="windows">
 
 import SetupWestNRF91Windows from '/docs/partials-common/setup-west-nrf91-windows.md'
 
-<SetupWestNRF91Windows />
+<SetupWestNRF91Windows workspace_directory="golioth-ncs-workspace" />
 
 </TabItem>
 </Tabs>
diff --git a/docs/partials-common/setup-zephyr-unix.md b/docs/partials-common/setup-zephyr-unix.md
index 4efa923c..595ca2dd 100644
--- a/docs/partials-common/setup-zephyr-unix.md
+++ b/docs/partials-common/setup-zephyr-unix.md
@@ -1,10 +1,10 @@
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 We recommend creating a `python3` virtual environment to avoid running into
 tooling incompatibilities.
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
 <Tabs
 groupId="west-installation"
 defaultValue="global"
@@ -19,15 +19,15 @@ Create a new version environment:
 Even though we haven't pulled down Zephyr yet, we can create the virtual environment in the place where we _will_ pull
 down Zephyr.
 
-```
-python3 -m venv ~/golioth-zephyr-workspace/.venv
-```
+<CodeBlock>
+python3 -m venv ~/{props.workspace_directory}/.venv
+</CodeBlock>
 
 Activate the virtual environment:
 
-```
-source ~/golioth-zephyr-workspace/.venv/bin/activate
-```
+<CodeBlock>
+source ~/{props.workspace_directory}/.venv/bin/activate
+</CodeBlock>
 
 Whenever the virtual environment is active, your shell's prompt will be prefixed with `(.venv)`.
 
diff --git a/docs/partials-common/setup-zephyr-windows.md b/docs/partials-common/setup-zephyr-windows.md
index 646222a6..d817bb14 100644
--- a/docs/partials-common/setup-zephyr-windows.md
+++ b/docs/partials-common/setup-zephyr-windows.md
@@ -34,13 +34,13 @@ values={[
 
     ```shell
     cd c:\
-    python -m venv golioth-zephyr-workspace\.venv
+    python -m venv {props.workspace_directory}\.venv
     ```
 
 2. Activate the virtual environment:
 
     ```shell
-    c:\golioth-zephyr-workspace\.venv\Scripts\activate.bat
+    c:\{props.workspace_directory}\.venv\Scripts\activate.bat
     ```
 
     Once activated your shell will be prefixed with `(.venv)`. The virtual environment can be deactivated at any time by running `deactivate`.
diff --git a/docs/partials-common/setup-zephyr.md b/docs/partials-common/setup-zephyr.md
index a4740619..30b4b14d 100644
--- a/docs/partials-common/setup-zephyr.md
+++ b/docs/partials-common/setup-zephyr.md
@@ -47,7 +47,7 @@ cmake --version
 
 If the Kitware repository doesn't work for you (ie: your system is not running Ubuntu 20.04), you can [build the stable version of CMake from source](https://cmake.org/install/).
 
-<SetupZephyrUnix />
+<SetupZephyrUnix workspace_directory="golioth-zephyr-workspace" />
 
 </TabItem>
 <TabItem value="macos">
@@ -58,7 +58,7 @@ Start by installing dependencies with `brew`:
 brew install cmake ninja gperf python3 ccache qemu dtc
 ```
 
-<SetupZephyrUnix />
+<SetupZephyrUnix workspace_directory="golioth-zephyr-workspace" />
 
 </TabItem>
 <TabItem value="windows">
@@ -99,7 +99,7 @@ The [chocolatey](https://chocolatey.org/) package manager needs to be installed
 
 import SetupZephyrWindows from './setup-zephyr-windows.md'
 
-<SetupZephyrWindows />
+<SetupZephyrWindows workspace_directory="golioth-zephyr-workspace" />
 
 </TabItem>
 </Tabs>