diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b9996e7..6882b72 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,5 +1,5 @@ repos: - repo: https://github.com/errata-ai/vale - rev: v3.7.1 + rev: v3.9.6 hooks: - id: vale diff --git a/assets/console/datasets-create-dark.png b/assets/console/datasets-create-dark.png new file mode 100644 index 0000000..4281157 Binary files /dev/null and b/assets/console/datasets-create-dark.png differ diff --git a/assets/console/datasets-create-light.png b/assets/console/datasets-create-light.png new file mode 100644 index 0000000..5fc29ce Binary files /dev/null and b/assets/console/datasets-create-light.png differ diff --git a/assets/console/datasets-create-temporal-dark.png b/assets/console/datasets-create-temporal-dark.png new file mode 100644 index 0000000..17c22c2 Binary files /dev/null and b/assets/console/datasets-create-temporal-dark.png differ diff --git a/assets/console/datasets-create-temporal-light.png b/assets/console/datasets-create-temporal-light.png new file mode 100644 index 0000000..0d0a319 Binary files /dev/null and b/assets/console/datasets-create-temporal-light.png differ diff --git a/assets/console/datasets-dark.png b/assets/console/datasets-dark.png deleted file mode 100644 index 260b0ba..0000000 Binary files a/assets/console/datasets-dark.png and /dev/null differ diff --git a/assets/console/datasets-documentation-dark.png b/assets/console/datasets-documentation-dark.png new file mode 100644 index 0000000..7c92d36 Binary files /dev/null and b/assets/console/datasets-documentation-dark.png differ diff --git a/assets/console/datasets-documentation-light.png b/assets/console/datasets-documentation-light.png new file mode 100644 index 0000000..9c395f4 Binary files /dev/null and b/assets/console/datasets-documentation-light.png differ diff --git a/assets/console/datasets-explorer-dark.png b/assets/console/datasets-explorer-dark.png new file mode 100644 index 0000000..62b235b Binary files /dev/null and b/assets/console/datasets-explorer-dark.png differ diff --git a/assets/console/datasets-explorer-light.png b/assets/console/datasets-explorer-light.png new file mode 100644 index 0000000..57e99fb Binary files /dev/null and b/assets/console/datasets-explorer-light.png differ diff --git a/assets/console/datasets-light.png b/assets/console/datasets-light.png deleted file mode 100644 index 95f8cb6..0000000 Binary files a/assets/console/datasets-light.png and /dev/null differ diff --git a/assets/console/datasets-overview-dark.png b/assets/console/datasets-overview-dark.png new file mode 100644 index 0000000..b73eab3 Binary files /dev/null and b/assets/console/datasets-overview-dark.png differ diff --git a/assets/console/datasets-overview-light.png b/assets/console/datasets-overview-light.png new file mode 100644 index 0000000..6e64365 Binary files /dev/null and b/assets/console/datasets-overview-light.png differ diff --git a/assets/console/usage-dark.png b/assets/console/usage-dark.png index 2d5d67b..4fb1185 100644 Binary files a/assets/console/usage-dark.png and b/assets/console/usage-dark.png differ diff --git a/assets/console/usage-light.png b/assets/console/usage-light.png index e60b7b7..1066f35 100644 Binary files a/assets/console/usage-light.png and b/assets/console/usage-light.png differ diff --git a/console.mdx b/console.mdx index da550b5..1109aad 100644 --- a/console.mdx +++ b/console.mdx @@ -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. - Tilebox Console - Tilebox Console + Tilebox Console + Tilebox Console When you click a specific event time in the data point list view, a detailed view of that data point will appear. diff --git a/datasets/managed-datasets/creating-dataset.mdx b/datasets/managed-datasets/creating-dataset.mdx new file mode 100644 index 0000000..027242c --- /dev/null +++ b/datasets/managed-datasets/creating-dataset.mdx @@ -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 + + + + Create a dataset in Tilebox by going to [My datasets](https://console.tilebox.com/datasets/my-datasets) and clicking the "Create dataset" button. + + + 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. + + + Tilebox Console + Tilebox Console + + + + 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. + + + Tilebox Console + Tilebox Console + + + + 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. + + + Tilebox Console + Tilebox Console + + + + Once you're done completing the fields, click "Create" to create the dataset. You are redirected to your newly created dataset. + + + +The next steps are to create at least one collection and ingest data into it. + +It might then resemble this: + + Tilebox Console + Tilebox Console + + +## 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. + + + If you don't see the edit pencil button, you don't have the required permissions to edit the + documentation. + + +## 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. + + + Tilebox Console + Tilebox Console + + +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. + + + If you don't see the edit pencil button, you don't have the required permissions to edit the + documentation. + + +Once you are done editing the documentation, click the `Save` button to save your changes. diff --git a/datasets/managed-datasets/data-types.mdx b/datasets/managed-datasets/data-types.mdx new file mode 100644 index 0000000..bdd3230 --- /dev/null +++ b/datasets/managed-datasets/data-types.mdx @@ -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). + + + If there is a data type you want to see in Tilebox, + please get in touch. + + +## Primitive types + + + A string of characters. + + + + A 64-bit signed integer. + + + + A 64-bit unsigned integer. + + + + A 64-bit floating-point number. + + + + A boolean. + + + + A sequence of bytes. + + +## Time types + + + A duration of time. See [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) for more information. + + + + A point in time. See [Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) for more information. + + +## Identifier types + + + A [universally unique identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier). + + +## Geospatial types + + + A latitude and longitude pair. + + + + A latitude, longitude, and altitude triplet. + + + + Geospatial geometries of type Point, LineString, Polygon or MultiPolygon. + diff --git a/mint.json b/mint.json index 09c38ab..df8762a 100644 --- a/mint.json +++ b/mint.json @@ -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" ]