Correcting and adding all the links.

biotz · Mar 1, 2024 · df60ed9 · df60ed9
1 parent e584672
commit df60ed9
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 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
@@ -27,8 +27,9 @@ After naming the schema the proper and important specification happens under the
 ![item types](/img/itemTypes.png)
 </div>
 
-Detailed specification of the item types is shared in here
-
+Detailed specification of the item types is shared in <a href="./Message-type Schema specification
+" target="_self">here</a>.
+‍
 - 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.
 
 <br></br>
 
-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 <a href="./How to publish device data" target="_self">other</a>.
+ 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
@@ -27,7 +27,8 @@ Now that we have our credentials created. We need to configure the authenticatio
 <div class="tutorial-image-container">
 ![developer](/img/biotz-developer-api.png)
 </div>
-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
+<a href="./" target="_self">Developer API</a>.
 
 - **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
@@ -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 <a href="http://localhost:3000/academy/docs/Tutorials/Creating%20a%20Biotz%20account/" target="_self">registered</a> in Biotz.
-- <a href="http://localhost:3000/academy/docs/Tutorials/Step%201%20-%20Creating%20a%20Device%20Type/" target="_self">Device-Type</a>, <a href="http://localhost:3000/academy/docs/Tutorials/Step%202%20-%20Creating%20a%20Message%20Type/" target="_self">message-type</a> and the schema of data <a href="http://localhost:3000/academy/docs/Tutorials/Step%203%20-%20Creating%20a%20Schema/" target="_self">schema of data</a> to be sent must be registered in Biotz.
+- Organisation must be <a href="./Creating a Biotz account" target="_self">registered</a> in Biotz.
+- <a href="./Step 1 - Creating a Device Type" target="_self">Device-Type</a>, <a href="./Step 2 - Creating a Message Type" target="_self">message-type</a> and the schema of data <a href="http://localhost:3000/academy/docs/Tutorials/Step%203%20-%20Creating%20a%20Schema/" target="_self">schema of data</a> to be sent must be registered in Biotz.
 - <a href="http://localhost:3000/academy/docs/Tutorials/Step%204%20-%20Creating%20%20a%20device/" target="_self">Specific</a> device must be registered.
 
-Find specific MQTT broker information following this link.
+Find specific MQTT broker information following this <a href="./MQTT broker" target="_self">link</a>.
 
 This is the generic MQTT topic builds:
 

diff --git 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 <a href="https://api.biotz.io/docs/ui/index.html#/" target="_self">here</a>. If you want to know how to authorize correctly before consuming the API go <a href="http://localhost:3000/academy/docs/How-to%20guides/How%20to%20create%20developer%20API%20credentials/" target="_self">here</a>.
+The API documentation with every available endpoint is <a href="https://api.biotz.io/docs/ui/index.html#/" target="_self">here</a>. If you want to know how to authorize correctly before consuming the API go <a href="./How to create developer API credentials" target="_self">here</a>.
 
 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
@@ -2,16 +2,15 @@
 - Host: mqtts://broker.biotz.io
 - Port: 8883
 - Transport: TLS
-- MQTT version: v3.1.1
-
+- MQTT version: <a href="http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/csprd02/mqtt-v3.1.1-csprd02.html/" target="_self">v3.1.1</a>
 ## Authentication
 The authentication values are generated and provided when a new device is registered in the Biotz Platform. Each device uses its own credentials.
 
 - **Client id**: generated and provided when a device is registered.
 - **Username**: generated and provided when a device is registered.
 - **Password**: generated and provided when a device is registered.
 
-More information about device registration <a href="http://localhost:3000/academy/docs/Tutorials/Step%204%20-%20Creating%20%20a%20device/" target="_self">here</a>.
+More information about device registration <a href="./Step 4 - Creating  a device" target="_self">here</a>.
 
 ## Topics
 
@@ -22,19 +21,20 @@ More information about device registration <a href="http://localhost:3000/academ
 ```
 biotz/1/0/CUSTOMER-ID/DEVICE-ID/publish/data/MESSAGE-TYPE-INTERNAL-NAME
 ```
-<a href="http://localhost:3000/academy/docs/How-to%20guides/How%20to%20publish%20device%20data/" target="_self">More information</a>
+<a href="./How to publish device data" target="_self">More information</a>
 ### Subscribe
 
 #### Remote actioning:‍
 
 ```
 biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/action/ACTION-MESSAGE-TYPE-INTERNAL-NAME
 ```
-<a href="http://localhost:3000/academy/docs/How-to%20guides/How%20to%20configure%20and%20trigger%20a%20remote%20action%20in%20devices/" target="_self">More information</a>
+<a href="./How to configure and trigger a remote action in devices" target="_self">More information</a>
 
 ### Firmware updates:
 
 ```
 biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/firmware/update
 ```
-<a href="http://localhost:3000/academy/docs/How-to%20guides/How%20to%20update%20device%20firmware/" target="_self">More information</a>
+<a href="./How to update device firmware" target="_self">More information</a>
+
diff --git 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 <a href="/academy/docs/Tutorials/Step%201%20-%20Creating%20a%20Device%20Type.md" target="_self">creation of a Device Type</a>.
+With these concepts clarified, your initial task will involve the <a href="./Step 1 - Creating a Device Type" target="_self">creation of a Device Type</a>.
 
diff --git 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)
 </div>
 
-Now that you have created a Device Type, the next step is to <a href="./Step 2 - Creating a Message Type
-/" target="_self">create a Message Type </a>.
+Now that you have created a Device Type, the next step is to <a href="./Creating a Device Type
+" target="_self">create a Message Type </a>.
 
 
diff --git 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',