diff --git a/docs.json b/docs.json new file mode 100644 index 0000000..fa0dd5e --- /dev/null +++ b/docs.json @@ -0,0 +1,320 @@ +{ + "$schema": "https://mintlify.com/docs.json", + "theme": "mint", + "name": "Tilebox Docs", + "colors": { + "primary": "#f43f5e", + "light": "#FAFAFA", + "dark": "#09090b" + }, + "favicon": "/favicon.svg", + "navigation": { + "tabs": [ + { + "tab": "Documentation", + "groups": [ + { + "group": "Get Started", + "pages": [ + "introduction", + "quickstart", + "console", + "ai-assistance", + "authentication" + ] + }, + { + "group": "Datasets", + "pages": [ + "datasets/introduction", + { + "group": "Concepts", + "icon": "circle-nodes", + "pages": [ + "datasets/concepts/datasets", + "datasets/concepts/collections" + ] + }, + { + "group": "Dataset Types", + "icon": "puzzle", + "pages": [ + "datasets/types/timeseries", + "datasets/types/spatiotemporal" + ] + }, + "datasets/query", + "datasets/ingest", + "datasets/delete", + "datasets/open-data" + ] + }, + { + "group": "Storage", + "pages": [ + "storage/clients" + ] + }, + { + "group": "Workflows", + "pages": [ + "workflows/introduction", + { + "group": "Concepts", + "icon": "circle-nodes", + "pages": [ + "workflows/concepts/tasks", + "workflows/concepts/jobs", + "workflows/concepts/task-runners", + "workflows/concepts/clusters" + ] + }, + "workflows/caches", + { + "group": "Observability", + "icon": "eye", + "pages": [ + "workflows/observability/open-telemetry", + "workflows/observability/tracing", + "workflows/observability/logging" + ] + }, + { + "group": "Near-Real Time", + "icon": "bolt", + "pages": [ + "workflows/near-real-time/automations", + "workflows/near-real-time/cron", + "workflows/near-real-time/storage-events" + ] + } + ] + } + ] + }, + { + "tab": "User Guides", + "groups": [ + { + "group": "Datasets", + "pages": [ + "guides/datasets/create", + "guides/datasets/ingest", + "guides/datasets/ingest-format" + ] + }, + { + "group": "Workflows", + "pages": [ + "guides/workflows/multi-language" + ] + } + ] + }, + { + "tab": "Languages & SDKs", + "groups": [ + { + "group": "Tilebox SDKs", + "pages": [ + "sdks/introduction" + ] + }, + { + "group": "Python", + "pages": [ + "sdks/python/install", + "sdks/python/sample-notebooks", + "sdks/python/xarray", + "sdks/python/async", + "sdks/python/geometries" + ] + }, + { + "group": "Go", + "pages": [ + "sdks/go/install", + "sdks/go/examples", + "sdks/go/protobuf" + ] + } + ] + }, + { + "tab": "API Reference", + "groups": [ + { + "group": "Python", + "pages": [ + { + "group": "tilebox.datasets", + "pages": [ + "api-reference/python/tilebox.datasets/Client", + "api-reference/python/tilebox.datasets/Client.datasets", + "api-reference/python/tilebox.datasets/Client.dataset", + "api-reference/python/tilebox.datasets/Dataset.collections", + "api-reference/python/tilebox.datasets/Dataset.collection", + "api-reference/python/tilebox.datasets/Dataset.create_collection", + "api-reference/python/tilebox.datasets/Dataset.get_or_create_collection", + "api-reference/python/tilebox.datasets/Collection.delete", + "api-reference/python/tilebox.datasets/Collection.find", + "api-reference/python/tilebox.datasets/Collection.info", + "api-reference/python/tilebox.datasets/Collection.ingest", + "api-reference/python/tilebox.datasets/Collection.load" + ] + }, + { + "group": "tilebox.workflows", + "pages": [ + "api-reference/python/tilebox.workflows/Client", + "api-reference/python/tilebox.workflows/Task", + "api-reference/python/tilebox.workflows/Client.runner", + "api-reference/python/tilebox.workflows/TaskRunner.run_all", + "api-reference/python/tilebox.workflows/TaskRunner.run_forever", + "api-reference/python/tilebox.workflows/ExecutionContext.submit_subtask", + "api-reference/python/tilebox.workflows/ExecutionContext.job_cache", + "api-reference/python/tilebox.workflows/ClusterClient.create", + "api-reference/python/tilebox.workflows/ClusterClient.find", + "api-reference/python/tilebox.workflows/ClusterClient.delete", + "api-reference/python/tilebox.workflows/ClusterClient.all", + "api-reference/python/tilebox.workflows/JobCache.group", + "api-reference/python/tilebox.workflows/JobCache.__iter__", + "api-reference/python/tilebox.workflows/JobClient.submit", + "api-reference/python/tilebox.workflows/JobClient.find", + "api-reference/python/tilebox.workflows/JobClient.retry", + "api-reference/python/tilebox.workflows/JobClient.cancel", + "api-reference/python/tilebox.workflows/JobClient.visualize", + "api-reference/python/tilebox.workflows/JobClient.query" + ] + } + ] + }, + { + "group": "Go", + "pages": [ + { + "group": "datasets", + "pages": [ + "api-reference/go/datasets/Get", + "api-reference/go/datasets/List", + "api-reference/go/datasets/Collections.Create", + "api-reference/go/datasets/Collections.Get", + "api-reference/go/datasets/Collections.GetOrCreate", + "api-reference/go/datasets/Collections.List", + "api-reference/go/datasets/Datapoints.GetInto", + "api-reference/go/datasets/Datapoints.Query", + "api-reference/go/datasets/Datapoints.QueryInto", + "api-reference/go/datasets/Datapoints.Ingest", + "api-reference/go/datasets/Datapoints.Delete", + "api-reference/go/datasets/Datapoints.DeleteIDs", + "api-reference/go/datasets/CollectAs", + "api-reference/go/datasets/Collect", + "api-reference/go/datasets/As" + ] + }, + { + "group": "workflows", + "pages": [ + "api-reference/go/workflows/Task", + "api-reference/go/workflows/GetCurrentCluster", + "api-reference/go/workflows/SubmitSubtask", + "api-reference/go/workflows/SubmitSubtasks", + "api-reference/go/workflows/WithTaskSpan", + "api-reference/go/workflows/WithTaskSpanResult", + "api-reference/go/workflows/NewTaskRunner", + "api-reference/go/workflows/TaskRunner.GetRegisteredTask", + "api-reference/go/workflows/TaskRunner.RegisterTasks", + "api-reference/go/workflows/TaskRunner.Run", + "api-reference/go/workflows/Clusters.Create", + "api-reference/go/workflows/Clusters.Get", + "api-reference/go/workflows/Clusters.Delete", + "api-reference/go/workflows/Clusters.List", + "api-reference/go/workflows/Jobs.Submit", + "api-reference/go/workflows/Jobs.Get", + "api-reference/go/workflows/Jobs.Retry", + "api-reference/go/workflows/Jobs.Cancel", + "api-reference/go/workflows/Jobs.Query", + "api-reference/go/workflows/Collect" + ] + } + ] + } + ] + }, + { + "tab": "Changelog", + "groups": [ + { + "group": "Changelog", + "pages": [ + "changelog" + ] + } + ] + } + ], + "global": { + "anchors": [ + { + "anchor": "Console", + "href": "https://console.tilebox.com", + "icon": "terminal" + }, + { + "anchor": "Book a Demo", + "href": "https://book.vimcal.com/p/lauracosta/tilebox-demo", + "icon": "calendar" + }, + { + "anchor": "Discord", + "href": "https://tilebox.com/discord", + "icon": "discord" + } + ] + } + }, + "styling": { + "eyebrows": "section", + "codeblocks": "system" + }, + "logo": { + "light": "/logo/light.svg", + "dark": "/logo/dark.svg" + }, + "contextual": { + "options": [ + "copy", + "view" + ] + }, + "navbar": { + "links": [ + { + "label": "Website", + "href": "https://tilebox.com" + } + ], + "primary": { + "type": "button", + "label": "Console", + "href": "https://console.tilebox.com" + } + }, + "footer": { + "socials": { + "x": "https://x.com/tileboxio", + "github": "https://github.com/tilebox", + "linkedin": "https://www.linkedin.com/company/tilebox-io" + } + }, + "fonts": { + "heading": { + "family": "Poppins" + } + }, + "errors": { + "404": { + "redirect": false + } + } +} diff --git a/mint.json b/mint.json deleted file mode 100644 index d9c5677..0000000 --- a/mint.json +++ /dev/null @@ -1,307 +0,0 @@ -{ - "$schema": "https://mintlify.com/schema.json", - "name": "Tilebox Docs", - "logo": { - "dark": "/logo/dark.svg", - "light": "/logo/light.svg" - }, - "layout": "topnav", - "sidebar": { - "items": "border" - }, - "topbar": { - "style": "default" - }, - "rounded": "sharp", - "favicon": "/favicon.svg", - "colors": { - "primary": "#f43f5e", - "light": "#FAFAFA", - "dark": "#09090b" - }, - "font": { - "headings": { - "family": "Poppins" - } - }, - "codeBlock": { - "mode": "auto" - }, - "topbarLinks": [ - { - "name": "Website", - "url": "https://tilebox.com" - } - ], - "topbarCtaButton": { - "name": "Console", - "url": "https://console.tilebox.com" - }, - "tabs": [ - { - "name": "User Guides", - "url": "guides" - }, - { - "name": "Languages & SDKs", - "url": "sdks" - }, - { - "name": "API Reference", - "url": "api-reference" - }, - { - "name": "Changelog", - "url": "changelog" - } - ], - "primaryTab": { - "name": "Documentation" - }, - "anchors": [ - { - "name": "Console", - "icon": "terminal", - "url": "https://console.tilebox.com" - }, - { - "name": "Book a Demo", - "icon": "calendar", - "url": "https://book.vimcal.com/p/lauracosta/tilebox-demo" - }, - { - "name": "Discord", - "icon": "discord", - "url": "https://tilebox.com/discord" - } - ], - "navigation": [ - { - "group": "Get Started", - "pages": [ - "introduction", - "quickstart", - "console", - "ai-assistance", - "authentication" - ] - }, - { - "group": "Datasets", - "pages": [ - "datasets/introduction", - { - "group": "Concepts", - "icon": "circle-nodes", - "pages": [ - "datasets/concepts/datasets", - "datasets/concepts/collections" - ] - }, - { - "group": "Dataset Types", - "icon": "puzzle", - "pages": [ - "datasets/types/timeseries", - "datasets/types/spatiotemporal" - ] - }, - "datasets/query", - "datasets/ingest", - "datasets/delete", - "datasets/open-data" - ] - }, - { - "group": "Storage", - "pages": [ - "storage/clients" - ] - }, - { - "group": "Workflows", - "pages": [ - "workflows/introduction", - { - "group": "Concepts", - "icon": "circle-nodes", - "pages": [ - "workflows/concepts/tasks", - "workflows/concepts/jobs", - "workflows/concepts/task-runners", - "workflows/concepts/clusters" - ] - }, - "workflows/caches", - { - "group": "Observability", - "icon": "eye", - "pages": [ - "workflows/observability/open-telemetry", - "workflows/observability/tracing", - "workflows/observability/logging" - ] - }, - { - "group": "Near-Real Time", - "icon": "bolt", - "pages": [ - "workflows/near-real-time/automations", - "workflows/near-real-time/cron", - "workflows/near-real-time/storage-events" - ] - } - ] - }, - { - "group": "Tilebox SDKs", - "pages": [ - "sdks/introduction" - ] - }, - { - "group": "Python", - "pages": [ - "sdks/python/install", - "sdks/python/sample-notebooks", - "sdks/python/xarray", - "sdks/python/async", - "sdks/python/geometries" - ] - }, - { - "group": "Go", - "pages": [ - "sdks/go/install", - "sdks/go/examples", - "sdks/go/protobuf" - ] - }, - { - "group": "Datasets", - "pages": [ - "guides/datasets/create", - "guides/datasets/ingest", - "guides/datasets/ingest-format" - ] - }, - { - "group": "Workflows", - "pages": [ - "guides/workflows/multi-language" - ] - }, - { - "group": "Python", - "pages": [ - { - "group": "tilebox.datasets", - "pages": [ - "api-reference/python/tilebox.datasets/Client", - "api-reference/python/tilebox.datasets/Client.datasets", - "api-reference/python/tilebox.datasets/Client.dataset", - "api-reference/python/tilebox.datasets/Dataset.collections", - "api-reference/python/tilebox.datasets/Dataset.collection", - "api-reference/python/tilebox.datasets/Dataset.create_collection", - "api-reference/python/tilebox.datasets/Dataset.get_or_create_collection", - "api-reference/python/tilebox.datasets/Collection.delete", - "api-reference/python/tilebox.datasets/Collection.find", - "api-reference/python/tilebox.datasets/Collection.info", - "api-reference/python/tilebox.datasets/Collection.ingest", - "api-reference/python/tilebox.datasets/Collection.load" - ] - }, - { - "group": "tilebox.workflows", - "pages": [ - "api-reference/python/tilebox.workflows/Client", - "api-reference/python/tilebox.workflows/Task", - "api-reference/python/tilebox.workflows/Client.runner", - "api-reference/python/tilebox.workflows/TaskRunner.run_all", - "api-reference/python/tilebox.workflows/TaskRunner.run_forever", - "api-reference/python/tilebox.workflows/ExecutionContext.submit_subtask", - "api-reference/python/tilebox.workflows/ExecutionContext.job_cache", - "api-reference/python/tilebox.workflows/ClusterClient.create", - "api-reference/python/tilebox.workflows/ClusterClient.find", - "api-reference/python/tilebox.workflows/ClusterClient.delete", - "api-reference/python/tilebox.workflows/ClusterClient.all", - "api-reference/python/tilebox.workflows/JobCache.group", - "api-reference/python/tilebox.workflows/JobCache.__iter__", - "api-reference/python/tilebox.workflows/JobClient.submit", - "api-reference/python/tilebox.workflows/JobClient.find", - "api-reference/python/tilebox.workflows/JobClient.retry", - "api-reference/python/tilebox.workflows/JobClient.cancel", - "api-reference/python/tilebox.workflows/JobClient.visualize", - "api-reference/python/tilebox.workflows/JobClient.query" - ] - } - ] - }, - { - "group": "Go", - "pages": [ - { - "group": "datasets", - "pages": [ - "api-reference/go/datasets/Get", - "api-reference/go/datasets/List", - "api-reference/go/datasets/Collections.Create", - "api-reference/go/datasets/Collections.Get", - "api-reference/go/datasets/Collections.GetOrCreate", - "api-reference/go/datasets/Collections.List", - "api-reference/go/datasets/Datapoints.GetInto", - "api-reference/go/datasets/Datapoints.Query", - "api-reference/go/datasets/Datapoints.QueryInto", - "api-reference/go/datasets/Datapoints.Ingest", - "api-reference/go/datasets/Datapoints.Delete", - "api-reference/go/datasets/Datapoints.DeleteIDs", - "api-reference/go/datasets/CollectAs", - "api-reference/go/datasets/Collect", - "api-reference/go/datasets/As" - ] - }, - { - "group": "workflows", - "pages": [ - "api-reference/go/workflows/Task", - "api-reference/go/workflows/GetCurrentCluster", - "api-reference/go/workflows/SubmitSubtask", - "api-reference/go/workflows/SubmitSubtasks", - "api-reference/go/workflows/WithTaskSpan", - "api-reference/go/workflows/WithTaskSpanResult", - "api-reference/go/workflows/NewTaskRunner", - "api-reference/go/workflows/TaskRunner.GetRegisteredTask", - "api-reference/go/workflows/TaskRunner.RegisterTasks", - "api-reference/go/workflows/TaskRunner.Run", - "api-reference/go/workflows/Clusters.Create", - "api-reference/go/workflows/Clusters.Get", - "api-reference/go/workflows/Clusters.Delete", - "api-reference/go/workflows/Clusters.List", - "api-reference/go/workflows/Jobs.Submit", - "api-reference/go/workflows/Jobs.Get", - "api-reference/go/workflows/Jobs.Retry", - "api-reference/go/workflows/Jobs.Cancel", - "api-reference/go/workflows/Jobs.Query", - "api-reference/go/workflows/Collect" - ] - } - ] - }, - { - "group": "Changelog", - "pages": [ - "changelog" - ] - } - ], - "feedback": { - "thumbsRating": true, - "suggestEdit": true, - "raiseIssue": true - }, - "footerSocials": { - "x": "https://x.com/tileboxio", - "github": "https://github.com/tilebox", - "linkedin": "https://www.linkedin.com/company/tilebox-io" - } -} diff --git a/sdks/go/examples.mdx b/sdks/go/examples.mdx index 71e3ab0..54fa7d7 100644 --- a/sdks/go/examples.mdx +++ b/sdks/go/examples.mdx @@ -11,52 +11,28 @@ More examples can be found throughout the docs. ## Workflows examples - - + + How to use Tilebox Workflows to submit and execute a simple task. - - [ Open in - Github](https://github.com/tilebox/tilebox-go/tree/main/examples/workflows/helloworld) - - - + + How to submit a task and run a workflow using protobuf messages. - - [ Open in - Github](https://github.com/tilebox/tilebox-go/blob/main/examples/workflows/protobuf-task) - - - - How to set up tracing and logging for workflows using [Axiom](https://axiom.co/) observability platform. - - [ Open in - Github](https://github.com/tilebox/tilebox-go/tree/main/examples/workflows/axiom) - - - - How to set up tracing and logging for workflows using [OpenTelemetry](https://opentelemetry.io/). - - [ Open in - Github](https://github.com/tilebox/tilebox-go/blob/main/examples/workflows/opentelemetry) - - - + + + How to set up tracing and logging for workflows using Axiom observability platform. + + + How to set up tracing and logging for workflows using OpenTelemetry. + + ## Datasets examples - - - How to query datapoints from a Tilebox dataset. - - [ Open in - Github](https://github.com/tilebox/tilebox-go/blob/main/examples/datasets/query/main.go) - - - + + + How to query datapoints from a Tilebox dataset. + + How to create a collection, ingest datapoints, and then delete them. - - [ Open in - Github](https://github.com/tilebox/tilebox-go/blob/main/examples/datasets/ingest/main.go) - - - + + diff --git a/style.css b/style.css new file mode 100644 index 0000000..b0045bd --- /dev/null +++ b/style.css @@ -0,0 +1,4 @@ +/* As deviation from the mint theme: we want to remove the rounded corners */ +* { + border-radius: 0 !important; +}