Skip to content

Commit

Permalink
Organizing images and changing the code for them to work
Browse files Browse the repository at this point in the history
  • Loading branch information
aitormurgu committed Mar 7, 2024
1 parent 54e6bb9 commit 787570b
Show file tree
Hide file tree
Showing 77 changed files with 55 additions and 173 deletions.
12 changes: 0 additions & 12 deletions blog/2019-05-28-first-blog-post.md

This file was deleted.

44 changes: 0 additions & 44 deletions blog/2019-05-29-long-blog-post.md

This file was deleted.

20 changes: 0 additions & 20 deletions blog/2021-08-01-mdx-blog-post.mdx

This file was deleted.

Binary file not shown.
25 changes: 0 additions & 25 deletions blog/2021-08-26-welcome/index.md

This file was deleted.

17 changes: 0 additions & 17 deletions blog/authors.yml

This file was deleted.

8 changes: 4 additions & 4 deletions docs/How-to guides/How to create a dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ In order to create a dashboard having a device-type with at least one message ty
Dashboards are created from the “Dashboards” list. Just a name and an optional description are requested.

<div class="tutorial-image-container">
![Dashboards](/img/dashboards.png)
![Dashboards](/academy/docs/How-to guides/img/dashboards.png)
</div>

When clicking on “create” an empty dashboard is created.
<div class="tutorial-image-container">
![Empty dashboard](/img/empty-dashboard.png)
![Empty dashboard](/academy/docs/How-to guides/img/empty-dashboard.png)
</div>

## Creating panels
Expand All @@ -33,7 +33,7 @@ A dashboard is composed of one or more panels. To create a new one use the “Ne
At the moment the available panel types are the following: time-series, pie chart and gauge.

<div class="tutorial-image-container">
![Creating panels](/img/creating-panels.png)
![Creating panels](/academy/docs/How-to guides/img/creating-panels.png)
</div>

### General information
Expand Down Expand Up @@ -70,7 +70,7 @@ The reason for aggregating the data is performance. Lets say a certain device is
###### Appearance

<div class="tutorial-image-container">
![appearance](/img/appearance.png)
![appearance](/academy/docs/How-to guides/img/appearance.png)
</div>

The following appearance related options are available:
Expand Down
10 changes: 5 additions & 5 deletions docs/How-to guides/How to create a schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ In order to create a schema having a deceive-type with at least one message type
Schemas are created from the Setup > Data ingestion flow > Device-type > Message-type “New schema”

<div class="tutorial-image-container">
![Creating a schema](/img/creating-schema.png)
![Creating a schema](/academy/docs/How-to guides/img/creating-schema.png)
</div>
When clicking on “New schema” an empty schema is created.

<div class="tutorial-image-container">
![New schema](/img/new-schema.png)
![New schema](/academy/docs/How-to guides/img/new-schema.png)
</div>
First thing will be giving a name to the schema, the purpose of this is just to identify it, it is not further used in the communication or data sending.

Expand All @@ -31,7 +31,7 @@ First thing will be giving a name to the schema, the purpose of this is just to
After naming the schema the proper and important specification happens under the ‘Schema definition’ section. It is time to let Biotz know how the sending data is structured. Once ‘Add new item’ is selected, a set of different item types are offered to cover almost all the data sending options:

<div class="tutorial-image-container">
![Item types](/img/item-types.png)
![Item types](/academy/docs/How-to guides/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>.
Expand Down Expand Up @@ -59,15 +59,15 @@ These are the descriptions of each of the parameters of an item:
- Can be null?

<div class="tutorial-image-container">
![parameters](/img/parameters.png)
![parameters](/academy/docs/How-to guides/img/parameters.png)
</div>

Timestamp ones, the same as the rest with an extra one:

- Payload timestamp?: to be marked if this is the timestamp Biotz should use for the time series date mark.

<div class="tutorial-image-container">
![Payload Timestamp](/img/payload-timestamp.png)
![Payload Timestamp](/academy/docs/How-to guides/img/payload-timestamp.png)
</div>

Once the schema is totally represented the ‘save’ button will register the schema. This will create the necessary machinery for the data validation and ingestion, it will also create the needed database structure for the data to be stored.
Expand Down
12 changes: 6 additions & 6 deletions docs/How-to guides/How to create developer API credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@ To create applications that consume our data we have a Developer API, following
In order to connect with the API, you need to create some **credentials** in the credentials view, under the **Developer API** section

<div class="tutorial-image-container">
![Credentials creation](/img/credentials-creation.png)
![Credentials creation](/academy/docs/How-to guides/img/credentials-creation.png)
</div>


Once here, clicking in the **New credentials** button will redirect you to the form. In this view we have to set the credentials name, a description can also be set to differentiate better between one another.
<div class="tutorial-image-container">
![New credentials](/img/new-credentials.png)
![New credentials](/academy/docs/How-to guides/img/new-credentials.png)
</div>
<br></br>

When finished, click **Save** and it will show the user information:
<div class="tutorial-image-container">
![Credentials created succesfully](/img/credentials-created-succesfully.png)
![Credentials created succesfully](/academy/docs/How-to guides/img/credentials-created-succesfully.png)
</div>
As shown in the pop-up, this information will only appear once. So download the credentials file and save somewhere safe.

## API consumption

Now that we have our credentials created. We need to configure the authentication. For this example we will use the API documentation mentioned before.
<div class="tutorial-image-container">
![Developer](/img/biotz-developer-api.png)
![Developer](/academy/docs/How-to guides/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>.
Expand All @@ -46,12 +46,12 @@ Clicking the **Authorize** button a pop-up will show, in which we need to add th
- **Scopes:** You need to check the openid box.

<div class="tutorial-image-container">
![Authorize1](/img/authorize-1.png)
![Authorize1](/academy/docs/How-to guides/img/authorize-1.png)
</div>
When the authorization is done correctly, you should see a pop-up saying that your **Authorized**.

<div class="tutorial-image-container">
![authorize2](/img/authorize-2.png)
![authorize2](/academy/docs/How-to guides/img/authorize-2.png)
</div>
With this your capable of consuming the API and get the needed data.

Expand Down
2 changes: 1 addition & 1 deletion docs/How-to guides/How to define alarm and triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The following are the available logical operators:
-NOT OR: The group is considered truthy if none of the individual conditions is met.

<div class="tutorial-image-container">
![Groups](/img/groups.png)
![Groups](//academy/docs/How-to guides/img/groups.png)
</div>

Conditions and groups can be nested to build complex rules.
Expand Down
16 changes: 8 additions & 8 deletions docs/How-to guides/How to invite users.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Only organization administrators can invite new users.

New users are created from the user list view. The list can be accessed from 'Users' in the 'Organization management' section in the sidebar menu.
<div class="tutorial-image-container">
![Invite New User](/img/invite-new-user.png)
![Invite New User](/academy/docs/How-to guides/img/invite-new-user.png)
</div>
There, new users can be created using the “Add new user” button.

<div class="tutorial-image-container">
![Add new user](/img/add-user.png)
![Add new user](/academy/docs/How-to guides/img/add-user.png)
</div>
For creating the new user only an email address is required. Upon pressing save, the web application will notify the user if the process was successful or not.

Expand All @@ -30,32 +30,32 @@ For creating the new user only an email address is required. Upon pressing save,
When a new user is created, a welcome email is sent.

<div class="tutorial-image-container">
![Accept Invitation](/img/accept-invitation.png)
![Accept Invitation](/academy/docs/How-to guides/img/accept-invitation.png)
</div>

The email contains a URL that the new user has to open when it’s ready to set up its login credentials.

<div class="tutorial-image-container">
![Login Credentials](/img/login-credentials.png)
![Login Credentials](/academy/docs/How-to guides/img/login-credentials.png)
</div>

Opening the URL will trigger another email to be sent.

<div class="tutorial-image-container">
![Actualizar Cuenta](/img/actualizar-cuenta.png)
![Actualizar Cuenta](/academy/docs/How-to guides/img/actualizar-cuenta.png)
</div>

Clicking on the second email will redirect the user to the authentication provider. There the user will have to type the password that wants to use to login into Biotz.

<div class="tutorial-image-container">
![Update Password](/img/update-password.png)
![Update Password](/academy/docs/How-to guides/img/update-password.png)
</div>

<div class="tutorial-image-container">
![Update Password2](/img/update-password-2.png)
![Update Password2](/academy/docs/How-to guides/img/update-password-2.png)
</div>
And finally the user will be redirected to the login page, where it can start using Biotz.
<div class="tutorial-image-container">
![Login Page](/img/login-page.png)
![Login Page](/academy/docs/How-to guides/img/login-page.png)
</div>

4 changes: 2 additions & 2 deletions docs/How-to guides/How to register devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Follow the steps:
- That will present the form for the device registration.

<div class="tutorial-image-container">
![Using the UI](/img/using-ui.png)
![Using the UI](/academy/docs/How-to guides/img/using-ui.png)
</div>

Parameters description:
Expand All @@ -48,7 +48,7 @@ Follow the steps:
- That will present the form for the device registration.
-
<div class="tutorial-image-container">
![Using the CSV way](/img/using-csv-way.png)
![Using the CSV way](/academy/docs/How-to guides/img/using-csv-way.png)
</div>
Parameters description:

Expand Down
6 changes: 3 additions & 3 deletions docs/How-to guides/How to use dashboard variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The dashboard has to be pre-created, and at least one device is needed.
The variables are created from the dashboard edition view. For that click on the “pencil” icon in the dashboard toolbar.

<div class="tutorial-image-container">
![Dashboard Toolbars](/img/dashboard-toolbar.png)
![Dashboard Toolbars](/academy/docs/How-to guides/img/dashboard-toolbar.png)
</div>

Creating a variable only requires specifying a name and selecting a device-type.
Expand All @@ -28,7 +28,7 @@ Creating a variable only requires specifying a name and selecting a device-type.
The dashboard variables are always device-type specific to ensure that all the selectable devices are compatible with the dashboard panel queries in which the variable is used.

<div class="tutorial-image-container">
![Documentation Dasboard](/img/documentation-dashboard.png)
![Documentation Dasboard](/academy/docs/How-to guides/img/documentation-dashboard.png)
</div>

Up to 4 variables can be defined.
Expand All @@ -41,7 +41,7 @@ Once a dashboard variable is defined it can be used when defining dashboard pane
For that, click on the “Variable, select a variable defined in the dashboard” in the query builder. Then select a specific variable from the list. Continue with the rest of the form as when selecting a specific device.

<div class="tutorial-image-container">
![Specific Device](/img/specific-device.png)
![Specific Device](/academy/docs/How-to guides/img/specific-device.png)
</div>

The dashboard variable is now ready to use. Changing the device in the dashboard view will update the corresponding panels.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/Reference guides/Glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ Dashboards:
**Event**: an event is something that happened within the Biotz platform and has been registered for tracking purposes. For example, when a user joins an organization an event is registered. The events can sometimes generate notifications for the users.

<div class="tutorial-image-container">
![Glossary](/img/glossary.png)
![Glossary](/academy/docs/Reference guides/img/glossary.png)
</div>
2 changes: 1 addition & 1 deletion docs/Reference guides/Message-type Schema specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Supported data types:
- <a href="https://msgpack.org/#core-types/" target="_self">MessagePack</a>
- DB column type
<div class="tutorial-image-container">
![Message type schema](/img/message-type-schema.png)
![Message type schema](/academy/docs/Reference guides/img/message-type-schema.png)
</div>

Additional information about some of the data types above:
Expand Down
File renamed without changes
File renamed without changes
Loading

0 comments on commit 787570b

Please sign in to comment.