Skip to content

Commit

Permalink
Merge pull request #3337 from reubenmiller/docs-update-external-url-r…
Browse files Browse the repository at this point in the history
…edirects

docs: update external urls which were being redirected
  • Loading branch information
reubenmiller authored Jan 17, 2025
2 parents 8f27697 + 3ebedd4 commit 630aa39
Show file tree
Hide file tree
Showing 12 changed files with 29 additions and 29 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ When possible, fill out as much detail in the pull request template as is
reasonable. Most important is to reference the GitHub issue that you are
addressing with the PR.

**NOTE:** GitHub has [a feature](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
**NOTE:** GitHub has [a feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue)
that will automatically close issues referenced with a keyword (such as "Fixes")
by a PR or commit once the PR/commit is merged. Don't use these keywords. We
don't want issues to be automatically closed. We want our testers to
Expand Down Expand Up @@ -242,7 +242,7 @@ it, including a sign-off) is maintained indefinitely and may be redistributed
consistent with this project or the open source license(s) involved.

In addition to [GitHub's privacy
statement](https://docs.github.com/en/github/site-policy/github-privacy-statement)
statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement)
extracting personal data from these projects for any other use than maintaining
the projects and communication related to it is prohibited, explicitly
prohibited is extracting email addresses for unsolicited bulk mails.
Expand All @@ -254,7 +254,7 @@ delete, or create files or merge a pull request on GitHub. If you enabled email
address privacy, then the commit author email address cannot be changed and is
\<username\>@users.noreply.github.com by default.

See [setting your commit email address on GitHub](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-on-github).
See [setting your commit email address on GitHub](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address).

In the upper-right corner of any page, click your profile photo, then click
**Settings**.
Expand All @@ -269,7 +269,7 @@ In the upper-right corner of any page, click your profile photo, then click
1. You can use the git config command to change the email address you associate
with your Git commits.

See [setting your commit email address in Git](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
See [setting your commit email address in Git](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address).

1. Open Git Bash.
2. Set an email address in Git. You can use your GitHub-provided no-reply email
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.txt)
[![Discord Shield](https://discord.com/api/guilds/832211156520796171/widget.png?style=shield)](https://discord.gg/SvqWp6nrsK)
[![Discord Shield](https://discord.com/api/guilds/832211156520796171/widget.png?style=shield)](https://discord.com/invite/SvqWp6nrsK)
[![Build and Deploy to Github Pages](/~https://github.com/thin-edge/thin-edge.io/actions/workflows/gh-pages.yml/badge.svg)](/~https://github.com/thin-edge/thin-edge.io/actions/workflows/gh-pages.yml)
[![build-workflow](/~https://github.com/thin-edge/thin-edge.io/actions/workflows/build-workflow.yml/badge.svg)](/~https://github.com/thin-edge/thin-edge.io/actions/workflows/build-workflow.yml)
<!--- [![codecov](https://codecov.io/gh/thin-edge/thin-edge.io/branch/main/graph/badge.svg?token=ZE7576TLOK)](https://codecov.io/gh/thin-edge/thin-edge.io) --->
Expand Down Expand Up @@ -33,10 +33,10 @@
## Jump right in:
* [**Explore the Docs**](https://thin-edge.github.io/thin-edge.io/)
* [Install thin-edge.io on your device](https://thin-edge.github.io/thin-edge.io/install/)
* [Getting started with thin-edge.io on a Raspberry Pi](https://thin-edge.github.io/thin-edge.io/start/getting-started)
* [Connect your device to Cumulocity](https://thin-edge.github.io/thin-edge.io/start/connect-c8y)
* [Connect your device to Azure](https://thin-edge.github.io/thin-edge.io/start/connect-azure)
* [Connect your device to AWS](https://thin-edge.github.io/thin-edge.io/start/connect-aws)
* [Getting started with thin-edge.io on a Raspberry Pi](https://thin-edge.github.io/thin-edge.io/start/getting-started/)
* [Connect your device to Cumulocity](https://thin-edge.github.io/thin-edge.io/start/connect-c8y/)
* [Connect your device to Azure](https://thin-edge.github.io/thin-edge.io/start/connect-azure/)
* [Connect your device to AWS](https://thin-edge.github.io/thin-edge.io/start/connect-aws/)
* [Find some projects that work together with thin-edge.io](/~https://github.com/thin-edge/thin-edge.io_examples)
<br/>
<br/>
Expand All @@ -55,7 +55,7 @@ With thin-edge.io we want to provide re-usable and modular components, which are
<!-- REFERENCESYSTEMS -->

# Reference Systems
For an overview of the supported platforms please have a look at the [documentation](https://thin-edge.github.io/thin-edge.io/references/supported-platforms).
For an overview of the supported platforms please have a look at the [documentation](https://thin-edge.github.io/thin-edge.io/references/supported-platforms/).
<br/>
<br/>

Expand Down Expand Up @@ -85,7 +85,7 @@ Distributed under the Apache 2.0 License. See [LICENSE](LICENSE.txt) for more in
<!-- CONTACT -->
# Contact

Discord - [Join the thin-edge.io community now!](https://discord.gg/BXkVCbZk4a)
Discord - [Join the thin-edge.io community now!](https://discord.com/invite/SvqWp6nrsK)

LinkedIn - [@thin_edge_io](https://www.linkedin.com/company/thin-edge/)

Expand Down
2 changes: 1 addition & 1 deletion design/decisions/0005-tedge-watchdog.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In production, devices in the field need some protection against technical and n

## Proposal

Tools such as [monit](https://mmonit.com/monit) offer a flexible way for users to provide a functional-level monitoring/watchdog mechanism. Users can write rules to detect error scenarios, and run some corrective action to try and return the system to a functional state. In additional, monit can utilize thin-edge.io's telemetry API to publish events when such error scenarios are detected to provide feedback to system maintainers in the cloud that some devices are problems. For example, an event can be sent if the disk usage is too high, the File Descriptors are exhausted, the memory is too high. All of these metrics are only sent whilst in the error condition which means that it does not consume unnecessary network bandwidth sending the disk usage or memory usage to the cloud which incurs cost due to increase data volume usage, and cloud storage costs.
Tools such as [monit](https://mmonit.com/monit/) offer a flexible way for users to provide a functional-level monitoring/watchdog mechanism. Users can write rules to detect error scenarios, and run some corrective action to try and return the system to a functional state. In additional, monit can utilize thin-edge.io's telemetry API to publish events when such error scenarios are detected to provide feedback to system maintainers in the cloud that some devices are problems. For example, an event can be sent if the disk usage is too high, the File Descriptors are exhausted, the memory is too high. All of these metrics are only sent whilst in the error condition which means that it does not consume unnecessary network bandwidth sending the disk usage or memory usage to the cloud which incurs cost due to increase data volume usage, and cloud storage costs.

### Advantages

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ See [this repository](/~https://github.com/thin-edge/tedge-docs) to build the docu

## Writing guidelines

This documentation is written along [the documentation system](https://documentation.divio.com/).
This documentation is written along [the documentation system](https://docs.divio.com/documentation-system/).
6 changes: 3 additions & 3 deletions docs/src/contribute/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ Current MSRV is `1.65`.
### Cross compilation toolchain (optional)

%%te%% can be compiled for target architecture on non-target device, this is called cross compilation.
Currently we support `Raspberry Pi 3B` for `armv7` architecture with Rust's cross compilation toolchain called [cargo cross](/~https://github.com/rust-embedded/cross).
Currently we support `Raspberry Pi 3B` for `armv7` architecture with Rust's cross compilation toolchain called [cargo cross](/~https://github.com/cross-rs/cross).

To install [cargo cross](/~https://github.com/rust-embedded/cross):
To install [cargo cross](/~https://github.com/cross-rs/cross):

```sh
cargo install cross
Expand Down Expand Up @@ -179,7 +179,7 @@ total 2948

## Cross compiling

To create binaries which can run on different platform than one you are currently on you can use [cargo cross](/~https://github.com/rust-embedded/cross):
To create binaries which can run on different platform than one you are currently on you can use [cargo cross](/~https://github.com/cross-rs/cross):

```sh
cross build --target armv7-unknown-linux-gnueabihf
Expand Down
2 changes: 1 addition & 1 deletion docs/src/operate/monitoring/systemd-watchdog.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The health check request for service is published to `te/device/main/service/<se
the health status response from that service is expected on `te/device/main/service/<service-name>/status/health` topic.

Once the health status response is received from a particular service, the `tedge-watchdog` service will send the
[systemd notification](https://www.freedesktop.org/software/systemd/man/sd_notify.html#) to systemd on behalf of that
[systemd notification](https://www.freedesktop.org/software/systemd/man/latest/sd_notify.html) to systemd on behalf of that
monitored service.

:::note
Expand Down
2 changes: 1 addition & 1 deletion docs/src/references/supported-platforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: List of supported platforms, CPU architectures and resource usage
In addition to a Linux based Operation system, the following requirements must also be fulfilled:

* At least ~40MB of RAM on the gateway device, ~8MB on a child device (see [notes](#memory-usage))
* [mosquitto](/~https://github.com/eclipse/mosquitto) MQTT Broker (see [notes](#recommended-mosquitto-version))
* [mosquitto](/~https://github.com/eclipse-mosquitto/mosquitto) MQTT Broker (see [notes](#recommended-mosquitto-version))

:::tip
If you are looking for new hardware it is highly recommended to choose a CPU which has at least 2 cores, as it provides a much more responsive experience and should provide enough processing headroom for future requirements.
Expand Down
8 changes: 4 additions & 4 deletions docs/src/start/connect-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ See this [tutorial](connect-c8y.md), if you want to connect Cumulocity instead.
See this [tutorial](connect-aws.md), if you want to connect AWS IoT instead.

Before you try to connect your device to Azure IoT, you need:
* Create a Azure **IoT Hub** in Azure portal as described [here](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal).
* Create a Azure **IoT Hub** in Azure portal as described [here](https://learn.microsoft.com/en-us/azure/iot-hub/create-hub).
* [Install %%te%% on your device](../install/index.md).

You can now use [`tedge` command](../references/cli/index.md) to:
Expand Down Expand Up @@ -103,7 +103,7 @@ Here provide the configuration parameters that are required to create the device
Upon successfully saved the configuration a new device has been created on the IoT Hub.
The new device can be seen on the IoT Hub portal by navigating to **Explores** &rarr; **IoT Devices**.

More info about registering a device can be found [here](https://docs.microsoft.com/en-us/azure/iot-edge/how-to-authenticate-downstream-device?view=iotedge-2018-06)
More info about registering a device can be found [here](https://learn.microsoft.com/en-us/azure/iot-edge/how-to-authenticate-downstream-device?view=iotedge-2018-06)

## Configure the device {#configure}

Expand Down Expand Up @@ -224,9 +224,9 @@ Alternatively, post your own custom messages on `az/messages/events/#` topic:
tedge mqtt pub az/messages/events/ '{"text": "My message"}'
```

To view the messages that were sent from the device to the cloud, follow this [document](https://docs.microsoft.com/en-us/azure/iot-hub/quickstart-send-telemetry-cli#create-and-monitor-a-device).
To view the messages that were sent from the device to the cloud, follow this [document](https://learn.microsoft.com/en-us/azure/iot-hub/quickstart-send-telemetry-cli#create-and-monitor-a-device).

More info about sending telemetry to Azure can be found [here](https://docs.microsoft.com/en-us/azure/iot-hub/quickstart-send-telemetry-dotnet)
More info about sending telemetry to Azure can be found [here](https://learn.microsoft.com/en-us/azure/iot/tutorial-send-telemetry-iot-hub)

## Next Steps

Expand Down
8 changes: 4 additions & 4 deletions docs/src/start/device-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Using these metrics, you can monitor the health of devices
and can proactively initiate actions in case the device seems to malfunction.
Additionally, the metrics can be used to help the customer troubleshoot when problems with the device are reported.

%%te%% uses the open source component [collectd](https://collectd.org/) to collect the metrics from the device.
%%te%% uses the open source component [collectd](https://www.collectd.org/) to collect the metrics from the device.
%%te%% translates the `collectd` metrics from their native format to the [%%te%% JSON](../understand/thin-edge-json.md) format
and then into the [cloud-vendor specific format](../understand/tedge-mapper.md).

![device monitoring with collectd](images/collectd-metrics.png)

## Install

Device monitoring is not enabled by default, however it can be enabled using a community package, [tedge-collectd-setup](https://cloudsmith.io/~thinedge/repos/community/packages/?q=name%3A%27%5Etedge-collectd-setup%24%27), which will install [collectd](https://collectd.org/) and configure some sensible defaults including monitoring of cpu, memory and disk metrics.
Device monitoring is not enabled by default, however it can be enabled using a community package, [tedge-collectd-setup](https://cloudsmith.io/~thinedge/repos/community/packages/?q=name%3A%27%5Etedge-collectd-setup%24%27), which will install [collectd](https://www.collectd.org/) and configure some sensible defaults including monitoring of cpu, memory and disk metrics.

```sh tab={"label":"Debian/Ubuntu"}
sudo apt-get install tedge-collectd-setup
Expand Down Expand Up @@ -50,13 +50,13 @@ You can further customize the default collectd configuration by editing the foll
/etc/collectd/collectd.conf
```

Details about collectd plugins and their configuration can be viewed directly from the [collectd documentation](https://collectd.org/documentation/manpages/collectd.conf.html).
Details about collectd plugins and their configuration can be viewed directly from the [collectd documentation](https://www.collectd.org/documentation/manpages/collectd.conf.html).

However keep in mind the following points when editing the file:

1. __MQTT must be enabled__.
* %%te%% expects the `collectd` metrics to be published on the local MQTT bus.
Hence, you must enable the [MQTT write plugin of collectd](https://collectd.org/documentation/manpages/collectd.conf.html#plugin-mqtt).
Hence, you must enable the [MQTT write plugin of collectd](https://www.collectd.org/documentation/manpages/collectd.conf.html).
* The MQTT plugin is available on most distribution of `collectd`, but this is not the case on MacOS using homebrew.
If you are missing the MQTT plugin, please recompile `collectd` to include the MQTT plugin.
See [/~https://github.com/collectd/collectd](/~https://github.com/collectd/collectd) for details.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/start/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ When you go to events (`Device management` &rarr; `your device` &rarr; `events`)

With %%te%% device monitoring, you can collect metrics from the device and forward these device metrics to Cumulocity.

Device monitoring can be enabled by installing a community package, [tedge-collectd-setup](https://cloudsmith.io/~thinedge/repos/community/packages/?q=name%3A%27%5Etedge-collectd-setup%24%27), which will install [collectd](https://collectd.org/) and configure some sensible defaults including monitoring of cpu, memory and disk metrics.
Device monitoring can be enabled by installing a community package, [tedge-collectd-setup](https://cloudsmith.io/~thinedge/repos/community/packages/?q=name%3A%27%5Etedge-collectd-setup%24%27), which will install [collectd](https://www.collectd.org/) and configure some sensible defaults including monitoring of cpu, memory and disk metrics.

```sh tab={"label":"Debian/Ubuntu"}
sudo apt-get install tedge-collectd-setup
Expand Down
2 changes: 1 addition & 1 deletion docs/src/understand/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ We were looking for a widely-used, performant IPC mechanism and we investigated
In the end, we decided to use MQTT for the following reasons:
* The approach is used by other industrial IoT organisations and software,
for example by [Open Industry 4.0 Alliance](https://openindustry4.com/).
* Existing components (like [Node-RED](https://nodered.org/) or [collectd](https://collectd.org/) )
* Existing components (like [Node-RED](https://nodered.org/) or [collectd](https://www.collectd.org/) )
that support MQTT can be easily integrated. In this case, %%te%% acts as an MQTT proxy:
existing components connect to the local MQTT bus of %%te%%,
and %%te%% routes the messages to different clouds in a secure and reliable manner.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/understand/tedge-mapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The Azure IoT Hub Mapper processes a message in the following ways.

1. Validates if it is a correct %%te%% JSON message or not.
2. Validates the incoming message size is below 255 KB.
[The size of all device-to-cloud messages must be up to 256 KB](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-d2c-guidance).
[The size of all device-to-cloud messages must be up to 256 KB](https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-d2c-guidance).
The mapper keeps 1 KB as a buffer for the strings added by Azure.
3. (default) Adds a current timestamp if a timestamp is not included in an incoming message. To stop this behavior, please refer to the following instruction.

Expand Down

0 comments on commit 630aa39

Please sign in to comment.