Create the SETUP.md and fix incorrect links

biotz · Mar 14, 2024 · bf89843 · bf89843
1 parent a02a609
commit bf89843
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 14 deletions.
diff --git a/SETUP.md b/SETUP.md
@@ -0,0 +1,39 @@
+# Setup for Running the project Locally with Docker
+
+This document outlines the steps to configure and run an the project using Docker in your local environment.
+
+## Prerequisites
+
+Make sure you have the following instaled on your system.
+
+- Docker Engine: [Installation Instructions](https://docs.docker.com/engine/install/ubuntu/)
+- Docker Compose: [Installation Instructions](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04)
+
+## Configuration Steps
+
+### 1. Clone the repository
+
+```bash
+git clone https://github.com/your_username/your_project.git
+```
+
+### 2. Navigate to the Project Directory
+
+
+```bash
+cd your_project
+```
+
+### 3. Build and Run the Containers
+
+  ```bash
+    docker-compose up --build
+```
+
+This will build the necessary images and run the containers according to the configuration in `docker-compose.yml`.
+
+### 4. Access Your Application
+
+Open a web browser and visit `http://localhost:3000` (or the port you specified) to access your application.
+
+---
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
@@ -22,7 +22,7 @@ Biotz shows the same interface for both message types (specific to communication
 
 ## Step 2 - Setup device to get the order to perform the action.
 
-Find specific MQTT broker information following this <a href="/academy/docs/Reference guides/MQTT broker" target="_self">link</a>.
+Find specific MQTT broker information following this <a href="/docs/Reference guides/MQTT broker" target="_self">link</a>.
 
 The specific device of the selected device type should be already registered under the 'Device Management' section for devices. The device should be configured to SUBSCRIBE to the specific topic that Biotz will use to notify the action to the device. The topic follows this pattern:
 

diff --git a/docs/How-to guides/How to create a schema.md b/docs/How-to guides/How to create a schema.md
@@ -34,7 +34,7 @@ After naming the schema the proper and important specification happens under the
 ![Item types](img/item-types.png)
 </div>
 
-Detailed specification of the item types is shared in <a href="/academy/docs/Reference guides/Message-type Schema specification"target="_self">here</a>.
+Detailed specification of the item types is shared in <a href="/docs/Reference guides/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.

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
@@ -36,7 +36,7 @@ Now that we have our credentials created. We need to configure the authenticatio
 ![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
-<a href="/academy/docs/Reference guides/Developer API" target="_self">Developer API Reference</a>.
+<a href="/docs/Reference guides/Developer API" target="_self">Developer API Reference</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
@@ -6,11 +6,11 @@ sidebar_label: How to publish device data using MQTT - setup devices to send dat
 ## 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="/academy/docs/Tutorials/Creating a Biotz account" target="_self">registered</a> in Biotz.
-- <a href="/academy/docs/Tutorials/Getting started/Step 1 - Creating a Device Type" target="_self">Device-Type</a>, <a href="/academy/docs/Tutorials/Getting started/Step 2 - Creating a Message Type" target="_self">message-type</a> and the schema of data <a href="/academy/docs/Tutorials/Getting started/Step 3 - Creating a Schema" target="_self">schema of data</a> to be sent must be registered in Biotz.
-- <a href="/academy/docs/Tutorials/Getting started/Step 4 - Creating  a device" target="_self">Specific</a> device must be registered.
+- Organisation must be <a href="/docs/Tutorials/Creating a Biotz account" target="_self">registered</a> in Biotz.
+- <a href="/docs/Tutorials/Getting started/Step 1 - Creating a Device Type" target="_self">Device-Type</a>, <a href="/docs/Tutorials/Getting started/Step 2 - Creating a Message Type" target="_self">message-type</a> and the schema of data <a href="/docs/Tutorials/Getting started/Step 3 - Creating a Schema" target="_self">schema of data</a> to be sent must be registered in Biotz.
+- <a href="/docs/Tutorials/Getting started/Step 4 - Creating  a device" target="_self">Specific</a> device must be registered.
 
-Find specific MQTT broker information following this <a href="/academy/docs/Reference guides/MQTT broker" target="_self">link</a>.
+Find specific MQTT broker information following this <a href="/docs/Reference guides/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
@@ -2,12 +2,12 @@
 sidebar_position: 4
 ---
 
-# Developer API 
+# Developer API
 
 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="/academy/docs/How-to guides/How to create developer API credentials" 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="/docs/How-to guides/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
@@ -16,7 +16,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 <a href="/academy/docs/Tutorials/Getting started/Step 1 - Creating a Device Type" target="_self">here</a>.
+More information about device registration <a href="/docs/Tutorials/Getting started/Step 1 - Creating a Device Type" target="_self">here</a>.
 
 ## Topics
 
@@ -27,7 +27,7 @@ More information about device registration <a href="/academy/docs/Tutorials/Gett
 ```
 biotz/1/0/CUSTOMER-ID/DEVICE-ID/publish/data/MESSAGE-TYPE-INTERNAL-NAME
 ```
-<a href="/academy/docs/How-to guides/How to publish device data" target="_self">More information</a>
+<a href="/docs/How-to guides/How to publish device data" target="_self">More information</a>
 
 ### Subscribe
 
@@ -36,12 +36,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
 ```
-<a href="/academy/docs/How-to guides/How to configure and trigger a remote action in devices" target="_self">More information</a>
+<a href="/docs/How-to guides/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="/academy/docs/How-to guides/How to update device firmware" target="_self">More information</a>
+<a href="/docs/How-to guides/How to update device firmware" target="_self">More information</a>
 
diff --git a/docs/Tutorials/Getting started/index.md b/docs/Tutorials/Getting started/index.md
@@ -28,5 +28,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/Getting started/Step 1 - Creating a Device Type" target="_self">creation of a Device Type</a>.
+With these concepts clarified, your initial task will involve the <a href="/docs/Tutorials/Getting started/Step 1 - Creating a Device Type" target="_self">creation of a Device Type</a>.