From df60ed9649a89473f304397904ec1ac85025eee3 Mon Sep 17 00:00:00 2001 From: Aitor Murguzur Date: Fri, 1 Mar 2024 17:18:43 +0100 Subject: [PATCH] Correcting and adding all the links. --- docs/How-to guides/How to create a schema.md | 10 ++++++---- .../How to create developer API credentials.md | 3 ++- docs/How-to guides/How to publish device data.md | 6 +++--- docs/Reference guides/Developer API.md | 2 +- docs/Reference guides/MQTT broker.md | 12 ++++++------ docs/Tutorials/Getting started.md | 2 +- docs/Tutorials/Step 1 - Creating a Device Type.md | 4 ++-- docusaurus.config.ts | 2 +- 8 files changed, 22 insertions(+), 19 deletions(-) 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 a596228..be22384 100644 --- a/docs/How-to guides/How to create a schema.md +++ b/docs/How-to guides/How to create a schema.md @@ -27,8 +27,9 @@ After naming the schema the proper and important specification happens under the ![item types](/img/itemTypes.png) -Detailed specification of the item types is shared in here - +Detailed specification of the item types is shared in here. +‍ - Collection of identical items: collection of more than one identical item. Being an item anything from an object/map/dictionary to singular element as a text, boolean, integer or decimal. - Collection of unrelated items: collection of any kind of item, present just once. - Object / Map / Dictionary: They are containers of the final properties, as the collection type items. 1 to n items can be added to this one, they are grouped in two types based on the data needed to define them: @@ -77,9 +78,10 @@ The scheme must be a valid schema to be able to 'save' it.

-Next step should be setting up the other piece of the communication, the device. This other how-to guide talks about it. - +Next step should be setting up the other piece of the communication, the device. This other. + how-to guide talks about it. +‍ 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 d4338fa..e48fcbc 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 @@ -27,7 +27,8 @@ Now that we have our credentials created. We need to configure the authenticatio
![developer](/img/biotz-developer-api.png)
-Clicking the **Authorize** button a pop-up will show, in which we need to add this information, also found on the Developer API Reference: +Clicking the **Authorize** button a pop-up will show, in which we need to add this information, also found on the +Developer API. - **Username:** The username in the credentials file we have downloaded before. - **Password:** The password in the credentials file we have downloaded before. 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 6290a14..a541ff8 100644 --- a/docs/How-to guides/How to publish device data.md +++ b/docs/How-to guides/How to publish device data.md @@ -1,10 +1,10 @@ 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. -- Device-Type, message-type and the schema of data schema of data to be sent must be registered in Biotz. +- Organisation must be registered in Biotz. +- Device-Type, message-type and the schema of data schema of data to be sent must be registered in Biotz. - Specific device must be registered. -Find specific MQTT broker information following this link. +Find specific MQTT broker information following this link. This is the generic MQTT topic builds: diff --git a/docs/Reference guides/Developer API.md b/docs/Reference guides/Developer API.md index e683dec..01dc029 100644 --- a/docs/Reference guides/Developer API.md +++ b/docs/Reference guides/Developer API.md @@ -4,7 +4,7 @@ Here you can see the different data related to the developer API. # Reference data -The API documentation with every available endpoint is here. If you want to know how to authorize correctly before consuming the API go here. +The API documentation with every available endpoint is here. If you want to know how to authorize correctly before consuming the API go here. In order to connect correctly you'll need this data: diff --git a/docs/Reference guides/MQTT broker.md b/docs/Reference guides/MQTT broker.md index dd0b935..7e836f1 100644 --- a/docs/Reference guides/MQTT broker.md +++ b/docs/Reference guides/MQTT broker.md @@ -2,8 +2,7 @@ - Host: mqtts://broker.biotz.io - Port: 8883 - Transport: TLS -- MQTT version: v3.1.1 - +- MQTT version: v3.1.1 ## Authentication The authentication values are generated and provided when a new device is registered in the Biotz Platform. Each device uses its own credentials. @@ -11,7 +10,7 @@ The authentication values are generated and provided when a new device is regist - **Username**: generated and provided when a device is registered. - **Password**: generated and provided when a device is registered. -More information about device registration here. +More information about device registration here. ## Topics @@ -22,7 +21,7 @@ More information about device registration More information +More information ### Subscribe #### Remote actioning:‍ @@ -30,11 +29,12 @@ biotz/1/0/CUSTOMER-ID/DEVICE-ID/publish/data/MESSAGE-TYPE-INTERNAL-NAME ``` biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/action/ACTION-MESSAGE-TYPE-INTERNAL-NAME ``` -More information +More information ### Firmware updates: ``` biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/firmware/update ``` -More information \ No newline at end of file +More information + diff --git a/docs/Tutorials/Getting started.md b/docs/Tutorials/Getting started.md index 5f83855..8fbe80b 100644 --- a/docs/Tutorials/Getting started.md +++ b/docs/Tutorials/Getting started.md @@ -29,5 +29,5 @@ In this tutorial, you will be generating various resources within Biotz. As you - **Message Type Schema**: Every message adheres to a specific structure. In Biotz, this structure is termed a Schema. A Schema outlines the format of data for a given Message Type.‍ - **Device**: This refers to the tangible apparatus that dispatches data to the platform. -With these concepts clarified, your initial task will involve the creation of a Device Type. +With these concepts clarified, your initial task will involve the creation of a Device Type. diff --git a/docs/Tutorials/Step 1 - Creating a Device Type.md b/docs/Tutorials/Step 1 - Creating a Device Type.md index 2e740dd..3caf242 100644 --- a/docs/Tutorials/Step 1 - Creating a Device Type.md +++ b/docs/Tutorials/Step 1 - Creating a Device Type.md @@ -42,7 +42,7 @@ Leave the **Internal name** unchanged and click on **Save**. If there is nothing ![Confirm](/img/Created.png) -Now that you have created a Device Type, the next step is to create a Message Type . +Now that you have created a Device Type, the next step is to create a Message Type . diff --git a/docusaurus.config.ts b/docusaurus.config.ts index d43cf62..408baef 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -64,7 +64,7 @@ const config: Config = { position: 'left', label: 'Tutorial', }, - {to: '/blog', label: 'Blog', position: 'left',href: 'https://www.biotz.io/company/blog'}, + {to: '/blog', label: 'Blog', position: 'left'}, { href: 'https://www.biotz.io/contact-us',