Skip to content

Commit

Permalink
Changing and correcting the links
Browse files Browse the repository at this point in the history
  • Loading branch information
aitormurgu committed Feb 29, 2024
1 parent dcc43c1 commit a172f8b
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 8 deletions.
6 changes: 6 additions & 0 deletions docs/Tutorials/Creating a Biotz account.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
---

id: Creating a biotz account

---
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.

# Account registration


Please not that In order to complete this tutorial you will need a valid email address.

First navigate to the [Biotz Cloud](https://auth.biotz.io/realms/biotz-platform/protocol/openid-connect/auth?client_id=biotz-platform-spa&redirect_uri=https%3A%2F%2Fapp.biotz.io%2Foverview&state=9821fae0-b8ea-4b9f-b7f2-ebe9ad3c482c&response_mode=fragment&response_type=code&scope=openid&nonce=2063c301-fb70-4d7e-81f0-5790cefcf23f&ui_locales=en&code_challenge=bj-DokiKe4Pu4Xfta9-fhtiK1qjA8--GqPnUwWXfv1Y&code_challenge_method=S256). Once here you will be presented with the login page:
Expand Down
3 changes: 2 additions & 1 deletion docs/Tutorials/Getting started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +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="https://biotz.github.io/academy/docs/Tutorials/Step%201%20-%20Creating%20a%20Device%20Type/" target="_self">creation of a Device Type</a>.
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>.

9 changes: 8 additions & 1 deletion docs/Tutorials/Step 1 - Creating a Device Type.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---

id: Step 1-Creating a Device Type

---

# Creating a Device Type

Before we start sending and ingesting data you have to configure your Biotz account to be able to know **who** is sending data and **how** to process it. The first step is to create a Device Type, which will allow you to categorise your devices. Assuming you have signed in into the application, from the sidebar, in the **Setup** section, click on **Device Type**.
Expand Down Expand Up @@ -36,6 +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="http://localhost:3000/docs/Tutorials/Step%202%20-%20Creating%20a%20Message%20Type/" target="_self">create a Message Type </a>.
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>.


2 changes: 1 addition & 1 deletion docs/Tutorials/Step 2 - Creating a Message Type.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Fill the form with the following information:

To make the tutorial simpler, **HTTP communication protocol** and **JSON message encoding** are the right choices as they do not require as much to work with unlike **MQTT** and **Message Pack**. Leave the **internal name** as it is. Now click on create and you should now have a new Message Type to work with.

In the next step you will <a href="http://localhost:3000/docs/Tutorials/Step%203%20-%20Creating%20a%20Schema/" target="_self">create a Schema</a> for your newly created Message Type. Follow along.
In the next step you will <a href="./Step 3 - Creating a Schema" target="_self">create a Schema</a> for your newly created Message Type. Follow along.
2 changes: 1 addition & 1 deletion docs/Tutorials/Step 3 - Creating a Schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ For this tutorial we are not going to add this item, but in case you want to add
</div>


At this point, you have finished defining the schema you will use in this tutorial. It is now time to give it a name and finally create it. On the top of the screen, before the schema definition, you will have an input to write the name of the schema. Name it **My test schema** and click on **Create** down below. Once you have done that, you will have a schema on your list for the Message Type **My test message type**. Now you have all the basic ingredients that define your data ingestion flow. In the next step you will <a href="http://localhost:3000/docs/Tutorials/Step%204%20-%20Creating%20%20a%20device/" target="_self">create a device</a>.
At this point, you have finished defining the schema you will use in this tutorial. It is now time to give it a name and finally create it. On the top of the screen, before the schema definition, you will have an input to write the name of the schema. Name it **My test schema** and click on **Create** down below. Once you have done that, you will have a schema on your list for the Message Type **My test message type**. Now you have all the basic ingredients that define your data ingestion flow. In the next step you will <a href="./Step 4 - Creating a device" target="_self">create a device</a>.


2 changes: 1 addition & 1 deletion docs/Tutorials/Step 4 - Creating a device.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ From the **Device type** dropdown list select **My test device type**. Remember
![New Device2](/img/NewDevice2.png)
</div>

Now, click on **Save**. By doing so, Biotz will register the new device in the platform and perform certain actions to create the credentials for your device. Once it is done, you will automatically download the device credentials file. In the credentials file you will have important and sensitive information about your device. Among other things it contains the username and password of your device that is required to interact with Biotz services. Even though this is a tutorial, bear in mind that the credentials file should be stored in a safe place and avoid sharing it over the network. With this information before sending data to Biotz we need to <a href="http://localhost:3000/docs/Tutorials/Step%205%20-%20Authenticating%20%20a%20device/" target="_self">authenticate and get our token</a>.
Now, click on **Save**. By doing so, Biotz will register the new device in the platform and perform certain actions to create the credentials for your device. Once it is done, you will automatically download the device credentials file. In the credentials file you will have important and sensitive information about your device. Among other things it contains the username and password of your device that is required to interact with Biotz services. Even though this is a tutorial, bear in mind that the credentials file should be stored in a safe place and avoid sharing it over the network. With this information before sending data to Biotz we need to <a href="./Step 5 - Authenticating a device" target="_self">authenticate and get our token</a>.


2 changes: 1 addition & 1 deletion docs/Tutorials/Step 5 - Authenticating a device.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ curl --request POST \
```
<br></br>

This will return a response which contains the **id_token**. Copy its value and hold on to it as you will need it to <a href="http://localhost:3000/docs/Tutorials/Step%206%20-%20Sending%20a%20data%20ingestion%20request/" target="_self">send the data ingestion request</a>.
This will return a response which contains the **id_token**. Copy its value and hold on to it as you will need it to <a href="./Step 6 - Sending a data ingestion request" target="_self">send the data ingestion request</a>.
3 changes: 2 additions & 1 deletion docs/Tutorials/Step 6 - Sending a data ingestion request.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ The response should look like this:
}
```

If that is the response you got, then the request was successful. Now your data should be available on the platform. To see that, in the next step you will create a dashboard to display your data.
If that is the response you got, then the request was successful. Now your data should be available on the platform. To see that, in the next step you will <a href="./Step 7 - Displaying the data" target="_self">create a dashboard</a> to display your data.


3 changes: 2 additions & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ const config: Config = {
position: 'left',
label: 'Tutorial',
},
{to: '/blog', label: 'Blog', position: 'left'},
{to: '/blog', label: 'Blog', position: 'left',href: 'https://www.biotz.io/company/blog'},
{

href: 'https://www.biotz.io/contact-us',
label: 'Contact us',
position: 'right',
Expand Down

0 comments on commit a172f8b

Please sign in to comment.