Skip to content

Commit

Permalink
Finishing all the text
Browse files Browse the repository at this point in the history
  • Loading branch information
aitormurgu committed Feb 28, 2024
1 parent 952c385 commit b32678b
Show file tree
Hide file tree
Showing 19 changed files with 43 additions and 519 deletions.
3 changes: 3 additions & 0 deletions docs/How-to guides/How to create a dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ 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)
</div>
![Dashboards](/img/Dashboards.png)

When clicking on “create” an empty dashboard is created.
Expand Down
8 changes: 5 additions & 3 deletions docs/How-to guides/How to create a schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,18 @@ These are the descriptions of each of the parameters of an item:
- Item name: the name of the column where this data will be stored.
- Mandatory?
- Can be null?
-
![parameters](/img/parameters.png)

<div class="tutorial-image-container">
![parameters](/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/payloadTimestamp.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
3 changes: 2 additions & 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 @@ -62,8 +62,9 @@ The following are the available logical operators:
- NOT AND: The group is considered truthy if none or some, but not all individual conditions are met
-NOT OR: The group is considered truthy if none of the individual conditions is met.

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

</div>

Conditions and groups can be nested to build complex rules.
### Notifications
Expand Down
22 changes: 16 additions & 6 deletions docs/How-to guides/How to invite users.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,47 @@ Only organization administrators can invite new users.
## Invite a new user

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/InviteNewUser.png)

</div>
There, new users can be created using the “Add new user” button.

<div class="tutorial-image-container">
![Add new user](/img/AddUser.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.

## Accept invitation

When a new user is created, a welcome email is sent.

<div class="tutorial-image-container">
![Accept Invitation](/img/AcceptInvitation.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/LoginCredentials.png)
</div>

Opening the URL will trigger another email to be sent.

<div class="tutorial-image-container">
![Actualizar Cuenta](/img/ActualizarCuenta.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/UpdatePassword.png)
</div>

<div class="tutorial-image-container">
![Update Password2](/img/UpdatePassword2.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/LoginPage.png)

</div>

6 changes: 5 additions & 1 deletion docs/How-to guides/How to register devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ Follow the steps:
- At the right side top of this new view there will be a button that says 'New device'.
- That will present the form for the device registration.

<div class="tutorial-image-container">
![Using the UI](/img/UsingUI.png)
</div>

Parameters description:
- Device type - compulsory -: select the device type already created.
Expand All @@ -38,8 +40,10 @@ Follow the steps:
- From the lateral menu navigate to 'Device management - Devices'.
- At the right side top of this new view there will be a button that says 'Create devices form CSV'.
- That will present the form for the device registration.
-
<div class="tutorial-image-container">
![Using the CSV way](/img/UsingCSVway.png)

</div>
Parameters description:

- Device type - compulsory -: select the device type already created.
Expand Down
7 changes: 6 additions & 1 deletion docs/How-to guides/How to use dashboard variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,18 @@ 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/dashboardToolbar.png)
</div>

Creating a variable only requires specifying a name and selecting a device-type.
<br></br>

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/documentationDashboard.png)

</div>

Up to 4 variables can be defined.

Expand All @@ -31,6 +34,8 @@ 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/SpecificDevice.png)
</div>

The dashboard variable is now ready to use. Changing the device in the dashboard view will update the corresponding panels.
8 changes: 0 additions & 8 deletions docs/tutorial-basics/_category_.json

This file was deleted.

23 changes: 0 additions & 23 deletions docs/tutorial-basics/congratulations.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/tutorial-basics/create-a-blog-post.md

This file was deleted.

57 changes: 0 additions & 57 deletions docs/tutorial-basics/create-a-document.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/tutorial-basics/create-a-page.md

This file was deleted.

31 changes: 0 additions & 31 deletions docs/tutorial-basics/deploy-your-site.md

This file was deleted.

Loading

0 comments on commit b32678b

Please sign in to comment.