diff --git a/docs/src/overview.md b/docs/src/overview.md index d67090fb8c7..718b9e7a223 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -1,69 +1,66 @@ --- +title: Overview slug: / sidebar_position: 0 --- -# Overview +Welcome to {{te}}'s documentation! -Welcome to `thin-edge.io`'s documentation! - -`thin-edge.io` is an open-source development toolbox designed for rapid development of IoT agents. +{{te}} is an open-source development toolbox designed for rapid development of IoT agents. It is based on a versatile set of ready-to-use software components that can be easily combined with application-specific extensions into smart, secure, robust and efficient IoT agents which integrate cloud services, edge computing and operational technologies. -A typical agent uses as a foundation the building blocks provided by thin-edge +A typical agent uses as a foundation the building blocks provided by {{te}} for telemetry data processing and cloud connectivity as well as for device monitoring, configuration and updates. In combination with these blocks, the agent designer can provide application-specific extensions, -which cooperate with thin-edge over MQTT and HTTP along a JSON API, +which cooperate with {{te}} over MQTT and HTTP along a JSON API, to address any hardware, protocol or use-case specificity. -As such, `thin-edge.io` is good choice for implementing smart-equipment +As such, {{te}} is good choice for implementing smart-equipment that collect in-situ real-time data, perform analytics on the edge, forward key data to the cloud, and need to be secured, configured and updated at scale. -## How to start +## How to start {#start} The easiest way to get started is either to install the docker based [demo container](https://github.com/thin-edge/tedge-demo-container) -that showcases thin-edge.io and all its features or with the [beginner-friendly tutorial](start/getting-started.md) -that introduces `thin-edge.io` and guides you on how to install it on a Raspberry Pi. +that showcases {{te}} and all its features or with the [beginner-friendly tutorial](start/getting-started.md) +that introduces {{te}} and guides you on how to install it on a Raspberry Pi. After the installation you can directly connect your device to [Cumulocity IoT](https://www.cumulocity.com/guides/concepts/introduction/), and then monitor it from the cloud. You can also explore the main use-cases using these [tutorials](start/index.md). You will learn to: -- [install thin-edge on your specific hardware](install/index.md), +- [install {{te}} on your specific hardware](install/index.md), - connect your device to your cloud, whether [Cumulocity IoT](start/connect-c8y.md), [Azure IoT](start/connect-azure.md) or [AWS IoT](start/connect-aws.md), - [send telemetry data](start//send-thin-edge-data.md), [alarms](start//raise-alarm.md) and [events](start//send-events.md), - operate, configure, update, monitor your device. -## The concepts - - [Architecture FAQ](understand/faq.md) - - [Thin Edge Json](understand/thin-edge-json.md) - - [The Mapper](understand/tedge-mapper.md) - - [Software Management](understand/software-management.md) +## The concepts {#concepts} + +Better understand how {{te}} works by reviewing the core [Concepts](understand/index.md). -## How to operate a device with thin-edge.io +## How to operate a device {#operate} -Thin-edge provides a set of building blocks to operate, configure, update, monitor your devices. +{{te}} provides a set of building blocks to operate, configure, update, monitor your devices. * Use the [how-to guides](operate/index.md) on a daily basis * Refer to the [reference guides](references/index.md) for any in-depth details -## How to extend thin-edge.io +## How to extend {#extend} -One of the core feature of thin-edge is to be extensible. +One of the core feature of {{te}} is to be extensible. - [Write a software-management plugin](extend/write-my-software-management-plugin.md) -- [Build Operating System images with thin-edge.io setup to perform Over-the-Air (OTA) updates](extend/firmware-management/index.md) +- [Build Operating System images with {{te}} setup to perform Over-the-Air (OTA) updates](extend/firmware-management/index.md) -## How to contribute +## How to contribute {#contribute} -[`thin-edge.io`](https://github.com/thin-edge/thin-edge.io) is an open-source project +[{{te}}](https://github.com/thin-edge/thin-edge.io) is an open-source project released under the [Apache License - Version 2.0](https://github.com/thin-edge/thin-edge.io/blob/main/LICENSE.txt). All contributions are greatly appreciated.