Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refactor overview and start pages #2630

Merged
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
43 changes: 20 additions & 23 deletions docs/src/overview.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,66 @@
---
title: Overview
slug: /
sidebar_position: 0
---

# Overview
Welcome to %%te%%'s documentation!
reubenmiller marked this conversation as resolved.
Show resolved Hide resolved

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.
Expand Down
21 changes: 3 additions & 18 deletions docs/src/start/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,8 @@ tags: [Getting Started]
sidebar_position: 1
---

# Getting started
import DocCardList from '@theme/DocCardList';

- [Install](../install/index.md)
- [Getting Started](./getting-started.md)

## Cloud connections
- [Connect my device to Cumulocity IoT](./connect-c8y.md)
- [Connect my device to Azure IoT](./connect-azure.md)
- [Connect my device to AWS IoT](./connect-aws.md)

## Sending telemetry data
- [Send Thin Edge Json data](./send-thin-edge-data.md)
- [Raise alarms](./raise-alarm.md)
- [Send events](./send-events.md)

## Device monitoring and management
- [Monitor my device](./device-monitoring.md)
- [Manage my device software](./software-management.md)
- [Operations Management for Cumulocity IoT](../operate/c8y/supported_operations.md)
The getting started section guides you through your first steps with %%te%%.

<DocCardList />