Modify sidebar configuration

In order to modify the ordering of sections we have added the needed files and markdown metadata Co-authored-by: Aitor Murguzur <[email protected]>
biotz · Mar 5, 2024 · 3ed8eee · 3ed8eee
1 parent d6e4090
commit 3ed8eee
Show file tree

Hide file tree

Showing 24 changed files with 48 additions and 53 deletions.
diff --git a/docs/How-to guides/How to configure and trigger a remote action in devices.md b/docs/How-to guides/How to configure and trigger a remote action in devices.md
@@ -1,3 +1,9 @@
+---
+sidebar_position: 5
+---
+
+## Introduction
+
 Biotz offers the feature to action devices remotely, this is offered just through MQTT. The configuration of this features include 3 steps:
 
 <br></br>

diff --git a/docs/How-to guides/How to create a dashboard.md b/docs/How-to guides/How to create a dashboard.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 6
+---
 ## Introduction
 
 Biotz provides a dashboarding tool that can be used to visualize the data coming from the devices.

diff --git a/docs/How-to guides/How to create a schema.md b/docs/How-to guides/How to create a schema.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 3
+---
 ## Introduction
 
 When data arrives into Biotz's ingestion system, the received package of data is checked against schemas defined in Biotz. These schemas are the definition of the content of the data package and the user must take care of defining them in the system.

diff --git a/docs/How-to guides/How to create developer API credentials.md b/docs/How-to guides/How to create developer API credentials.md
@@ -1,3 +1,8 @@
+---
+sidebar_position: 10
+---
+## Introduction
+
 To create applications that consume our data we have a Developer API, following <a href="/academy/docs/Tutorials/Step 2 - Creating a Message Type" target="_self">this link</a> you will be able to consult more information about the endpoints in our documentation.
 
 ## Credentials creation

diff --git a/...o guides/How to debug communications coming from a device into the platform..md b/...o guides/How to debug communications coming from a device into the platform..md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 11
+---
 ## Introduction
 The communication debugger has as objective to help debug possible errors or problems related to the communication coming from the devices into Biotz Platform.
 

diff --git a/docs/How-to guides/How to define alarm and triggers.md b/docs/How-to guides/How to define alarm and triggers.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 8
+---
 ## Introduction
 
 Biotz provides alarm generation and notification capabilities based on the data received in the data ingestion flows. The alarm trigger or rules are evaluated against each received data observation, and when an alarm is triggered the corresponding users are notified.

diff --git a/docs/How-to guides/How to invite users.md b/docs/How-to guides/How to invite users.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 1
+---
 ## Introduction
 
 Organization administrators can invite new users to their organization. 

diff --git a/docs/How-to guides/How to publish device data.md b/docs/How-to guides/How to publish device data.md
@@ -1,3 +1,8 @@
+---
+sidebar_position: 4
+---
+
+## Introduction
 There is a standard format of the MQTT topics for sending data from devices to the Biotz IoT Platform. For this to happen there are these pre-steps that must be fulfilled:
 
 - Organisation must be <a href="./Creating a Biotz account" target="_self">registered</a> in Biotz.

diff --git a/docs/How-to guides/How to register devices.md b/docs/How-to guides/How to register devices.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 2
+---
 ## Introduction
 
 Biotz offers two ways for registering physical devices of a certain device type. This is used by Biotz to generate internal machinery for specific devices. But also as a way to have data of the collection of devices gathered together.

diff --git a/docs/How-to guides/How to update device firmware.md b/docs/How-to guides/How to update device firmware.md
@@ -1,3 +1,8 @@
+---
+sidebar_position: 9
+---
+
+## Introduction
 Biotz offers a remote firmware update service. The user will upload the new firmware file to the Biotz IoT platform where it will be registered and stored. From that point on the user will be able to assign any firmware file to existing devices.
 
 For this to be possible, the device must be subscribed to the MQTT topic where Biotz will publish the firmware update message. The topic name follows this format:

diff --git a/docs/How-to guides/How to use dashboard variables.md b/docs/How-to guides/How to use dashboard variables.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 7
+---
 ## Introduction
 
 Dashboard variables allow users to make dashboard panels more dynamic. Instead of hardcoding specific devices in the panels, device selectors can be added to the dashboard. Those selectors are displayed in the main dashboard view, and the selected value can be changed by the final users at any time. Changing the value updates the data for all the panels that are using that variable.

diff --git a/docs/Reference guides/_category_.json b/docs/Reference guides/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Reference guides",
-  "position": 2,
+  "position": 3,
   "link": {
     "type": "generated-index"
   }

diff --git a/docs/Tutorials/Creating a Biotz account.md b/docs/Tutorials/Creating a Biotz account.md
@@ -1,7 +1,6 @@
 ---
-
 id: Creating a biotz account
-
+sidebar_position: 1
 ---
 User registration is not currently available for the public. Please [contact us](https://www.biotz.io/contact-us) if you want to create an account.
 

diff --git a/...orials/Step 1 - Creating a Device Type.md → ...tarted/Step 1 - Creating a Device Type.md b/...orials/Step 1 - Creating a Device Type.md → ...tarted/Step 1 - Creating a Device Type.md
diff --git a/...rials/Step 2 - Creating a Message Type.md → ...arted/Step 2 - Creating a Message Type.md b/...rials/Step 2 - Creating a Message Type.md → ...arted/Step 2 - Creating a Message Type.md
diff --git a/docs/Tutorials/Step 3 - Creating a Schema.md → ...ing started/Step 3 - Creating a Schema.md b/docs/Tutorials/Step 3 - Creating a Schema.md → ...ing started/Step 3 - Creating a Schema.md
diff --git a/.../Tutorials/Step 4 - Creating a device.md → ...ng started/Step 4 - Creating a device.md b/.../Tutorials/Step 4 - Creating a device.md → ...ng started/Step 4 - Creating a device.md
diff --git a/...ials/Step 5 - Authenticating a device.md → ...rted/Step 5 - Authenticating a device.md b/...ials/Step 5 - Authenticating a device.md → ...rted/Step 5 - Authenticating a device.md
diff --git a/...p 6 - Sending a data ingestion request.md → ...p 6 - Sending a data ingestion request.md b/...p 6 - Sending a data ingestion request.md → ...p 6 - Sending a data ingestion request.md
diff --git a/...Tutorials/Step 7 - Displaying the data.md → ...g started/Step 7 - Displaying the data.md b/...Tutorials/Step 7 - Displaying the data.md → ...g started/Step 7 - Displaying the data.md
diff --git a/docs/Tutorials/Getting started/_category_.json b/docs/Tutorials/Getting started/_category_.json
@@ -0,0 +1,3 @@
+{
+  "label": "Getting started"
+}
diff --git a/docs/Tutorials/Getting started.md → docs/Tutorials/Getting started/index.md b/docs/Tutorials/Getting started.md → docs/Tutorials/Getting started/index.md
@@ -1,7 +1,5 @@
 ---
-
 id: Getting started
-
 ---
 
 # Getting started

diff --git a/docs/Tutorials/_category_.json b/docs/Tutorials/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Tutorials",
-  "position": 2,
+  "position": 1,
   "link": {
     "type": "generated-index"
   }

diff --git a/docs/intro.md b/docs/intro.md