From 3ed8eee1ef1b776a90d51fa4632d980da4ea46eb Mon Sep 17 00:00:00 2001 From: Mikel Elizondo Date: Tue, 5 Mar 2024 18:08:15 +0100 Subject: [PATCH] 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 --- ... and trigger a remote action in devices.md | 6 +++ .../How to create a dashboard.md | 3 ++ docs/How-to guides/How to create a schema.md | 3 ++ ...How to create developer API credentials.md | 5 ++ ...coming from a device into the platform..md | 3 ++ .../How to define alarm and triggers.md | 3 ++ docs/How-to guides/How to invite users.md | 3 ++ .../How to publish device data.md | 5 ++ docs/How-to guides/How to register devices.md | 3 ++ .../How to update device firmware.md | 5 ++ .../How to use dashboard variables.md | 3 ++ docs/Reference guides/_category_.json | 2 +- docs/Tutorials/Creating a Biotz account.md | 3 +- .../Step 1 - Creating a Device Type.md | 0 .../Step 2 - Creating a Message Type.md | 0 .../Step 3 - Creating a Schema.md | 0 .../Step 4 - Creating a device.md | 0 .../Step 5 - Authenticating a device.md | 0 ...ep 6 - Sending a data ingestion request.md | 0 .../Step 7 - Displaying the data.md | 0 .../Tutorials/Getting started/_category_.json | 3 ++ .../index.md} | 2 - docs/Tutorials/_category_.json | 2 +- docs/intro.md | 47 ------------------- 24 files changed, 48 insertions(+), 53 deletions(-) rename docs/Tutorials/{ => Getting started}/Step 1 - Creating a Device Type.md (100%) rename docs/Tutorials/{ => Getting started}/Step 2 - Creating a Message Type.md (100%) rename docs/Tutorials/{ => Getting started}/Step 3 - Creating a Schema.md (100%) rename docs/Tutorials/{ => Getting started}/Step 4 - Creating a device.md (100%) rename docs/Tutorials/{ => Getting started}/Step 5 - Authenticating a device.md (100%) rename docs/Tutorials/{ => Getting started}/Step 6 - Sending a data ingestion request.md (100%) rename docs/Tutorials/{ => Getting started}/Step 7 - Displaying the data.md (100%) create mode 100644 docs/Tutorials/Getting started/_category_.json rename docs/Tutorials/{Getting started.md => Getting started/index.md} (99%) delete mode 100644 docs/intro.md 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 index bebf725..7ea3a26 100644 --- 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:

diff --git a/docs/How-to guides/How to create a dashboard.md b/docs/How-to guides/How to create a dashboard.md index 02fe58d..edf03ba 100644 --- 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 index be22384..0ae8d1d 100644 --- 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 index 6d3add5..c7e58c1 100644 --- 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 this link you will be able to consult more information about the endpoints in our documentation. ## Credentials creation diff --git a/docs/How-to guides/How to debug communications coming from a device into the platform..md b/docs/How-to guides/How to debug communications coming from a device into the platform..md index d708213..b894d6d 100644 --- a/docs/How-to guides/How to debug communications coming from a device into the platform..md +++ b/docs/How-to 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 index 8f02bdc..77db862 100644 --- 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 index c19daf4..6f73499 100644 --- 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 index f5ab8c7..4438d98 100644 --- 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 registered in Biotz. diff --git a/docs/How-to guides/How to register devices.md b/docs/How-to guides/How to register devices.md index 015eedb..8972f87 100644 --- 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 index 1e27450..b2c5395 100644 --- 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 index a55932b..e61a8f5 100644 --- 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 index 985dc95..5d16aea 100644 --- 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 index dece3a6..66a51dd 100644 --- 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/docs/Tutorials/Step 1 - Creating a Device Type.md b/docs/Tutorials/Getting started/Step 1 - Creating a Device Type.md similarity index 100% rename from docs/Tutorials/Step 1 - Creating a Device Type.md rename to docs/Tutorials/Getting started/Step 1 - Creating a Device Type.md diff --git a/docs/Tutorials/Step 2 - Creating a Message Type.md b/docs/Tutorials/Getting started/Step 2 - Creating a Message Type.md similarity index 100% rename from docs/Tutorials/Step 2 - Creating a Message Type.md rename to docs/Tutorials/Getting started/Step 2 - Creating a Message Type.md diff --git a/docs/Tutorials/Step 3 - Creating a Schema.md b/docs/Tutorials/Getting started/Step 3 - Creating a Schema.md similarity index 100% rename from docs/Tutorials/Step 3 - Creating a Schema.md rename to docs/Tutorials/Getting started/Step 3 - Creating a Schema.md diff --git a/docs/Tutorials/Step 4 - Creating a device.md b/docs/Tutorials/Getting started/Step 4 - Creating a device.md similarity index 100% rename from docs/Tutorials/Step 4 - Creating a device.md rename to docs/Tutorials/Getting started/Step 4 - Creating a device.md diff --git a/docs/Tutorials/Step 5 - Authenticating a device.md b/docs/Tutorials/Getting started/Step 5 - Authenticating a device.md similarity index 100% rename from docs/Tutorials/Step 5 - Authenticating a device.md rename to docs/Tutorials/Getting started/Step 5 - Authenticating a device.md diff --git a/docs/Tutorials/Step 6 - Sending a data ingestion request.md b/docs/Tutorials/Getting started/Step 6 - Sending a data ingestion request.md similarity index 100% rename from docs/Tutorials/Step 6 - Sending a data ingestion request.md rename to docs/Tutorials/Getting started/Step 6 - Sending a data ingestion request.md diff --git a/docs/Tutorials/Step 7 - Displaying the data.md b/docs/Tutorials/Getting started/Step 7 - Displaying the data.md similarity index 100% rename from docs/Tutorials/Step 7 - Displaying the data.md rename to docs/Tutorials/Getting started/Step 7 - Displaying the data.md diff --git a/docs/Tutorials/Getting started/_category_.json b/docs/Tutorials/Getting started/_category_.json new file mode 100644 index 0000000..26aeaea --- /dev/null +++ b/docs/Tutorials/Getting started/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Getting started" +} diff --git a/docs/Tutorials/Getting started.md b/docs/Tutorials/Getting started/index.md similarity index 99% rename from docs/Tutorials/Getting started.md rename to docs/Tutorials/Getting started/index.md index 8fbe80b..7d135c2 100644 --- a/docs/Tutorials/Getting started.md +++ b/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 index 9db740a..98f179b 100644 --- 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 deleted file mode 100644 index 45e8604..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -### What you'll need - -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.