Merge Docs reorganization into Main

.github/workflows/firebase-hosting-merge-develop.yml

@@ -14,13 +14,17 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 20.9.0
-      - run: npm install && npm run build:dev
+      - name: Build Docusaurus
+        run: npm install && npm run build:dev
+      - name: Add robots.txt for Dev site only
+        run: echo -e ${{ format('User-agent{0} *\\nDisallow{1} /', ':', ':') }} > build/robots.txt
       - uses: FirebaseExtended/action-hosting-deploy@v0
         with:
           repoToken: '${{ secrets.GITHUB_TOKEN }}'
           firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_GOLIOTH }}'
           channelId: live
           projectId: golioth
           target: docs-dev
+          expires: 30d
         env:
           FIREBASE_CLI_PREVIEWS: hostingchannels

.github/workflows/firebase-hosting-merge-main.yml

@@ -22,5 +22,6 @@ jobs:
           channelId: live
           projectId: golioth
           target: docs-prod
+          expires: 30d
         env:
           FIREBASE_CLI_PREVIEWS: hostingchannels

.github/workflows/firebase-hosting-pull-request.yml

@@ -18,5 +18,6 @@ jobs:
           firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_GOLIOTH }}'
           projectId: golioth
           target: docs-dev
+          expires: 30d
         env:
           FIREBASE_CLI_PREVIEWS: hostingchannels

docs/partials-common/getting-started_choose-device.md → docs/_partials-common/getting-started_choose-device.md

@@ -1,4 +1,4 @@
 The next step is to connect a device to Golioth using either the Golioth
 Firmware SDK or the Golioth Zephyr SDK.
 
-## Next: [Hardware Overview](/hardware)
+## Next: [Hardware Overview](/firmware/hardware)

docs/hardware/2-esp32/1-espidf-quickstart/_partials/install-espidf.md → docs/_partials-common/install-espidf.md

@@ -17,7 +17,7 @@ values={[
 ```
 sudo apt update
 sudo apt-get install git wget flex bison gperf python3 python3-venv \
-  python3-pip python3-setuptools cmake ninja-build ccache libffi-dev 
+  python3-pip python3-setuptools cmake ninja-build ccache libffi-dev \
   libssl-dev dfu-util libusb-1.0-0
 ```
 
@@ -26,10 +26,8 @@ sudo apt-get install git wget flex bison gperf python3 python3-venv \
 ```console
 mkdir -p ~/esp
 cd ~/esp
-git clone --recursive https://github.com/espressif/esp-idf.git
+git clone --recursive https://github.com/espressif/esp-idf.git -b v5.1.1
 cd esp-idf
-git checkout v4.4.1
-git submodule update --init --recursive
 ./install.sh all
 ```
 
@@ -51,10 +49,8 @@ sudo easy_install pip
 ```console
 mkdir -p ~/esp
 cd ~/esp
-git clone --recursive https://github.com/espressif/esp-idf.git
+git clone --recursive https://github.com/espressif/esp-idf.git -b v5.1.1
 cd esp-idf
-git checkout v4.4.1
-git submodule update --init --recursive
 ./install.sh all
 ```
 

docs/hardware/2-esp32/1-espidf-quickstart/_partials/install-golioth-firmware-sdk.md → docs/_partials-common/install-golioth-firmware-sdk.md

@@ -12,13 +12,11 @@ values={[
 
 <TabItem value="linux">
 
-#### 1. Clone the Golioth Firmware SDK repository and update submodules
+#### Clone the Golioth Firmware SDK repository and update submodules recursively
 
 ```console
 cd ~
-git clone --recursive https://github.com/golioth/golioth-firmware-sdk.git
-cd golioth-firmware-sdk
-git submodule update --init --recursive
+git clone --recursive https://github.com/golioth/golioth-firmware-sdk.git -b v0.9.0
 ```
 
 </TabItem>
@@ -29,9 +27,7 @@ git submodule update --init --recursive
 
 ```console
 cd ~
-git clone --recursive https://github.com/golioth/golioth-firmware-sdk.git
-cd golioth-firmware-sdk
-git submodule update --init --recursive
+git clone --recursive https://github.com/golioth/golioth-firmware-sdk.git -b v0.9.0
 ```
 
 </TabItem>
@@ -42,9 +38,7 @@ git submodule update --init --recursive
 
 ```console
 cd %HOMEPATH%
-git clone --recursive https://github.com/golioth/golioth-firmware-sdk.git
-cd golioth-firmware-sdk
-git submodule update --init --recursive
+git clone --recursive https://github.com/golioth/golioth-firmware-sdk.git -b v0.9.0
 ```
 
 </TabItem>

docs/hardware/4-nrf91/2-zephyr-quickstart/_partials/install-nrf-connect-sdk-unix.md → docs/_partials-common/ncs-install-golioth-firmware-sdk-for-unix.md

@@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem';
 
 ```
 cd ~
-west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mf west-ncs.yml ~/golioth-ncs-workspace
+west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mr v0.9.0 --mf west-ncs.yml ~/golioth-ncs-workspace
 cd golioth-ncs-workspace
 west update
 ```

docs/hardware/4-nrf91/2-zephyr-quickstart/_partials/install-nrf-connect-sdk-windows.md → docs/_partials-common/ncs-install-golioth-firmware-sdk-for-windows.md

@@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem';
 
 ```
 cd %HOMEPATH%
-west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mf west-ncs.yml %HOMEPATH%/golioth-ncs-workspace
+west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mr v0.9.0 --mf west-ncs.yml %HOMEPATH%/golioth-ncs-workspace
 cd golioth-ncs-workspace
 west update
 ```

docs/_partials-common/ncs-install-golioth-firmware-sdk.md

@@ -0,0 +1,32 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+With `west` installed, grab the Golioth NCS SDK:
+
+<Tabs
+groupId="os"
+defaultValue="linux"
+values={[
+{label: 'Linux', value: 'linux'},
+{label: 'MacOS', value: 'macos'},
+{label: 'Windows', value: 'windows'},
+]}>
+
+import InstallNRFSDKUnix from '/docs/_partials-common/ncs-install-golioth-firmware-sdk-for-unix.md'
+import InstallNRFSDKWindows from '/docs/_partials-common/ncs-install-golioth-firmware-sdk-for-windows.md'
+
+<TabItem value="linux">
+<InstallNRFSDKUnix/>
+</TabItem>
+
+<TabItem value="macos">
+<InstallNRFSDKUnix/>
+</TabItem>
+
+<TabItem value="windows">
+<InstallNRFSDKWindows/>
+</TabItem>
+</Tabs>
+
+
+

docs/_partials-common/prerequisites-device.md

@@ -0,0 +1,13 @@
+### Prerequisites
+
+- `goliothctl` and `west` installed
+- Authenticated with Golioth - see
+  [Authentication](/reference/command-line-tools/tutorial/authentication)
+- Have a project - see [Create a
+  Project](/reference/command-line-tools/tutorial/create-project)
+- Have a provisioned device and credential for it - see [Authorizing
+  Devices](/reference/command-line-tools/tutorial/authorize-devices)
+  Zephyr](/getting-started/device-examples/compile-example-code/zephyr) page for the
+  ESP32.
+- A toolchain installed. In this guide, the toolchain for the ESP32 will be
+  used.

docs/_partials-common/prerequisites-platform-setup.md

@@ -0,0 +1,9 @@
+### Prerequisites
+
+- `goliothctl` and `west` installed
+- Authenticated with Golioth - see
+  [Authentication](/reference/command-line-tools/tutorial/authentication)
+- Have a project - see [Create a
+  Project](/reference/command-line-tools/tutorial/create-project)
+- Have a provisioned device and credential for it - see [Authorizing
+  Devices](/reference/command-line-tools/tutorial/manage-devices)

docs/partials-common/sample-build.mdx → docs/_partials-common/sample-build.mdx

@@ -2,6 +2,7 @@ import CodeBlock from '@theme/CodeBlock';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+export
 <Tabs
 groupId="os"
 defaultValue="linux"
@@ -14,25 +15,35 @@ values={[
 <TabItem value="linux">
 
 <CodeBlock language="bash">
-cd ~/golioth-zephyr-workspace/zephyr<br />
+cd ~/golioth-zephyr-workspace/zephyr
 west build -b {props.board} samples/basic/minimal -p
 </CodeBlock>
 
 </TabItem>
 <TabItem value="macos">
 
 <CodeBlock language="bash">
-cd ~/golioth-zephyr-workspace/zephyr<br />
+cd ~/golioth-zephyr-workspace/zephyr
 west build -b {props.board} samples/basic/minimal -p
 </CodeBlock>
 
 </TabItem>
 <TabItem value="windows">
 
 <CodeBlock language="bash">
-cd C:\golioth-zephyr-workspace\zephyr<br />
+cd C:\golioth-zephyr-workspace\zephyr
 west build -b {props.board} samples\basic\minimal -p
 </CodeBlock>
 
 </TabItem>
 </Tabs>
+
+<details>
+  <summary>Show me how to list all Zephyr supported boards</summary>
+
+If you don't know the name for your board, list all options using West:
+
+```
+west boards
+```
+</details>

docs/hardware/4-nrf91/2-zephyr-quickstart/_partials/setup-west-nrf91.md → docs/_partials-common/setup-west-nrf91.md

@@ -14,7 +14,7 @@ values={[
 {label: 'Windows', value: 'windows'},
 ]}>
 
-import SetupZephyrUnix from '/docs/partials-common/setup-zephyr-unix.md'
+import SetupZephyrUnix from '/docs/_partials-common/setup-zephyr-unix.md'
 
 <TabItem value="linux">
 
@@ -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/hardware/4-nrf91/2-zephyr-quickstart/\_partials/setup-west-nrf91-windows.md'
+import SetupWestNRF91Windows from '/docs/_partials-common/setup-west-nrf91-windows.md'
 
-<SetupWestNRF91Windows />
+<SetupWestNRF91Windows workspace_directory="golioth-ncs-workspace" />
 
 </TabItem>
 </Tabs>

docs/partials-common/setup-zephyr-unix.md → 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,17 +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
-# OR, if you're using the fish shell, run
-source ~/golioth-zephyr-workspace/.venv/bin/activate.fish
-```
+<CodeBlock>
+source ~/{props.workspace_directory}/.venv/bin/activate
+</CodeBlock>
 
 Whenever the virtual environment is active, your shell's prompt will be prefixed with `(.venv)`.
 

docs/partials-common/setup-zephyr-windows.md → 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`.

docs/partials-common/setup-zephyr.md → 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>

docs/partials-common/install-zephyr-sdk-unix.md → docs/_partials-common/zephyr-install-golioth-firmware-sdk-for-unix.md

@@ -9,7 +9,7 @@ Depending on your internet and I/O speed, `west update` can take upwards of 5 or
 
 ```
 cd ~
-west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mf west-zephyr.yml ~/golioth-zephyr-workspace
+west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mr v0.9.0 --mf west-zephyr.yml ~/golioth-zephyr-workspace
 cd golioth-zephyr-workspace
 west update
 ```

docs/partials-common/install-zephyr-sdk-windows.md → docs/_partials-common/zephyr-install-golioth-firmware-sdk-for-windows.md

@@ -5,8 +5,7 @@ import TabItem from '@theme/TabItem';
 
     ```shell
     cd c:\
-    west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mf west-zephyr.yml golioth-zephyr-workspace
-    cd golioth-zephyr-workspace
+    west init -m https://github.com/golioth/golioth-firmware-sdk.git --mr v0.9.0 --mf west-zephyr.yml golioth-zephyr-workspace
     west update
     ```
 

docs/partials-common/install-zephyr-sdk.md → docs/_partials-common/zephyr-install-golioth-firmware-sdk.md

@@ -10,18 +10,18 @@ values={[
 {label: 'Windows', value: 'windows'},
 ]}>
 
-import InstallZephyrSDKUnix from './install-zephyr-sdk-unix.md'
-import InstallZephyrSDKWindows from './install-zephyr-sdk-windows.md'
+import InstallGoliothSDKUnix from './zephyr-install-golioth-firmware-sdk-for-unix.md'
+import InstallGoliothSDKWindows from './zephyr-install-golioth-firmware-sdk-for-windows.md'
 
 <TabItem value="linux">
-<InstallZephyrSDKUnix/>
+<InstallGoliothSDKUnix/>
 </TabItem>
 
 <TabItem value="macos">
-<InstallZephyrSDKUnix/>
+<InstallGoliothSDKUnix/>
 </TabItem>
 
 <TabItem value="windows">
-<InstallZephyrSDKWindows/>
+<InstallGoliothSDKWindows/>
 </TabItem>
 </Tabs>