Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
repos:
- repo: https://github.com/errata-ai/vale
rev: v3.7.1
rev: v3.9.6
hooks:
- id: vale
Binary file added assets/console/datasets-create-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/console/datasets-create-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/console/datasets-create-temporal-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/console/datasets-create-temporal-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/console/datasets-dark.png
Binary file not shown.
Binary file added assets/console/datasets-documentation-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/console/datasets-documentation-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/console/datasets-explorer-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/console/datasets-explorer-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/console/datasets-light.png
Binary file not shown.
Binary file added assets/console/datasets-overview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/console/datasets-overview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/console/usage-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/console/usage-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The [Tilebox Console](https://console.tilebox.com) is a web interface that enabl
The datasets explorer lets you explore available datasets for your team. You can select a dataset, view its collections, and load data for a collection within a specified time range.

<Frame>
<img src="/assets/console/datasets-light.png" alt="Tilebox Console" className="dark:hidden" />
<img src="/assets/console/datasets-dark.png" alt="Tilebox Console" className="hidden dark:block" />
<img src="/assets/console/datasets-explorer-light.png" alt="Tilebox Console" className="dark:hidden" />
<img src="/assets/console/datasets-explorer-dark.png" alt="Tilebox Console" className="hidden dark:block" />
</Frame>

When you click a specific event time in the data point list view, a detailed view of that data point will appear.
Expand Down
93 changes: 93 additions & 0 deletions datasets/managed-datasets/creating-dataset.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: Creating a dataset
description: Learn how to create a dataset
icon: database
---

This page guides you through the process of creating a dataset in Tilebox.

## Step-by-step guide

<Steps>
<Step title="Click create">
Create a dataset in Tilebox by going to [My datasets](https://console.tilebox.com/datasets/my-datasets) and clicking the "Create dataset" button.
</Step>
<Step title="Select a dataset kind">
Choose a dataset kind from the dropdown menu. Prefilled fields for the selected dataset kind are automatically added.
Common fields for time series can be found [here](/datasets/timeseries#common-fields).
Support for STAC-compatible datasets is coming soon.

<Frame>
<img src="/assets/console/datasets-create-light.png" alt="Tilebox Console" className="dark:hidden" />
<img src="/assets/console/datasets-create-dark.png" alt="Tilebox Console" className="hidden dark:block" />
</Frame>
</Step>
<Step title="Fill in name, code name, and description">
Complete these fields:

- `Name` is the name of your dataset.
- `Code name` is a unique identifier for the dataset within your team. It's automatically generated, but you can adjust it if needed.
- `Description` is a brief description of the dataset purpose.

<Frame>
<img src="/assets/console/datasets-create-temporal-light.png" alt="Tilebox Console" className="dark:hidden" />
<img src="/assets/console/datasets-create-temporal-dark.png" alt="Tilebox Console" className="hidden dark:block" />
</Frame>
</Step>
<Step title="Fill in the fields">
Common fields for each dataset kind are added automatically. Click "Add field" to add more fields.

Each field has these properties:
- `Name` is the name of the field (it should be snake_case).
- `Type` and `Array` let you specify the field data type and whether it's an array. See below for an explanation of the available data.
- `Description` is an optional brief description of the field. You can use it to provide more context and details about the data.
- `Example value` is an optional example for this field. It can be useful for documentation purposes.

<Frame>
<img src="/assets/console/datasets-create-temporal-light.png" alt="Tilebox Console" className="dark:hidden" />
<img src="/assets/console/datasets-create-temporal-dark.png" alt="Tilebox Console" className="hidden dark:block" />
</Frame>
</Step>
<Step title="Create the dataset">
Once you're done completing the fields, click "Create" to create the dataset. You are redirected to your newly created dataset.
</Step>
</Steps>

The next steps are to create at least one collection and ingest data into it.

It might then resemble this:
<Frame>
<img src="/assets/console/datasets-overview-light.png" alt="Tilebox Console" className="dark:hidden" />
<img src="/assets/console/datasets-overview-dark.png" alt="Tilebox Console" className="hidden dark:block" />
</Frame>

## Editing a dataset

You can edit the dataset by clicking the edit pencil button on the dataset overview page.

On this page, you can change the dataset name, description, add new fields, and edit both description and example for existing fields.

<Note>
If you don't see the edit pencil button, you don't have the required permissions to edit the
documentation.
</Note>

## Adding documentation

In addition to the auto-generated overview page, you can add custom documentation to your dataset.
This documentation is displayed on the dataset page and can be used to provide more context and details about the data.

<Frame>
<img src="/assets/console/datasets-documentation-light.png" alt="Tilebox Console" className="dark:hidden" />
<img src="/assets/console/datasets-documentation-dark.png" alt="Tilebox Console" className="hidden dark:block" />
</Frame>

To add documentation, click the edit pencil button on the dataset page to open the documentation editor.
You can use Markdown to format your documentation; you can include links, tables, code snippets, and other Markdown features.

<Note>
If you don't see the edit pencil button, you don't have the required permissions to edit the
documentation.
</Note>

Once you are done editing the documentation, click the `Save` button to save your changes.
69 changes: 69 additions & 0 deletions datasets/managed-datasets/data-types.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: Data types
description: Learn
icon: file-binary
---

Tilebox supports primitives and data for data fields. These are defined in [well_known_types.proto](https://github.com/tilebox/tilebox-go/blob/main/apis/datasets/v1/well_known_types.proto).
Tilebox also uses Google well-known-types [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) and [Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp).

<Note>
If there is a data type you want to see in Tilebox,
<a href="mailto:support@tilebox.com">please get in touch</a>.
</Note>

## Primitive types

<ParamField path="string" type="Some string">
A string of characters.
</ParamField>

<ParamField path="int64" type="123">
A 64-bit signed integer.
</ParamField>

<ParamField path="uint64" type="123">
A 64-bit unsigned integer.
</ParamField>

<ParamField path="float64" type="123.45">
A 64-bit floating-point number.
</ParamField>

<ParamField path="bool" type="true">
A boolean.
</ParamField>

<ParamField path="bytes" type="Some bytes">
A sequence of bytes.
</ParamField>

## Time types

<ParamField path="Duration" type="12s 345ms">
A duration of time. See [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) for more information.
</ParamField>

<ParamField path="Timestamp" type="2023-05-17T14:30:00Z">
A point in time. See [Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) for more information.
</ParamField>

## Identifier types

<ParamField path="UUID" type="126a2531-c98d-4e06-815a-34bc5b1228cc">
A [universally unique identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier).
</ParamField>

## Geospatial types

<ParamField path="LatLon" type="48.8583° 2.2945°">
A latitude and longitude pair.
</ParamField>

<ParamField path="LatLonAlt" type="48.8583° 2.2945° 35m">
A latitude, longitude, and altitude triplet.
</ParamField>

<ParamField path="Geometry" type="POLYGON ((12.3 -5.4, 12.5 -5.4, ...))">
Geospatial geometries of type Point, LineString, Polygon or MultiPolygon.
</ParamField>
8 changes: 8 additions & 0 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,14 @@
"datasets/timeseries",
"datasets/collections",
"datasets/loading-data",
{
"group": "Managed datasets",
"icon": "bars-progress",
"pages": [
"datasets/managed-datasets/creating-dataset",
"datasets/managed-datasets/data-types"
]
},
"datasets/open-data",
"datasets/storage-clients"
]
Expand Down