Skip to content

Commit

Permalink
Merge pull request #2107 from reubenmiller/docs-fix-broken-doc-links
Browse files Browse the repository at this point in the history
docs: fix broken doc references
  • Loading branch information
reubenmiller authored Jul 28, 2023
2 parents 3610178 + 855ef28 commit da50f2e
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
</details>

## Jump right in:
* [**Explore the Docs**](https://thin-edge.github.io/thin-edge.io/html/)
* [**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)
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# You can find the [thin-edge.io documentation here](https://thin-edge.github.io/thin-edge.io/html/).
# You can find the [thin-edge.io documentation here](https://thin-edge.github.io/thin-edge.io/).

# Thin Edge Documentation: Writer Guidelines

Expand Down
2 changes: 1 addition & 1 deletion docs/src/operate/c8y/apama_software_management_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Apama plugin, part of the Apama thin-edge support package, can be used to in

The Apama thin-edge support package must be installed before you can install Apama projects on thin-edge.
The recommended way of installing Apama support on Debian based distributions is with the apt package manager.
Further details about this can be found in the thin-edge.io documentation at [Manage the software on your devices from Cumulocity cloud](https://thin-edge.github.io/thin-edge.io/html/tutorials/software-management.html).
Further details about this can be found in the thin-edge.io documentation at [Manage the software on your devices from Cumulocity cloud](../../start/software-management.md).

#### Set up the Debian repository from which the Apama packages will be installed

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Follow these steps to bootstrap the child device:

1. Create a `c8y-configuration-plugin.toml` file that contains the supported configuration list of the child-device

For example a list of configuration files in the same format as specified in the [configuration management documentation](https://thin-edge.github.io/thin-edge.io/html/howto-guides/025_config_management_plugin.html) as follows:
For example a list of configuration files in the same format as specified in the [configuration management documentation](../c8y/config_management_plugin.md) as follows:

```toml title="file: c8y-configuration-plugin.toml"
files = [
Expand Down Expand Up @@ -421,6 +421,6 @@ Performing config update is an 8-step process:

## References

* Configuration Management [documentation](https://thin-edge.github.io/thin-edge.io/html/howto-guides/child_device_config_management_agent.html)
* Configuration Management [documentation](../c8y/config_management_plugin.md)
* Reference implementation of a [child-device connector](https://github.com/thin-edge/thin-edge.io_examples/tree/main/child-device-agent) written in Python to demonstrate the contract described in this document.
* How to enable configuration [management on child-devices](https://github.com/thin-edge/thin-edge.io/blob/main/docs/src/howto-guides/child_device_config_management_agent.md)
* How to enable configuration [management on child-devices](../c8y/child_device_config_management_agent.md)
6 changes: 3 additions & 3 deletions docs/src/start/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This script will install the latest version of thin-edge.io with the following c
- Command line Interface (CLI) tool
- Tedge mapper

It is possible to do the installation of thin-edge.io manually or install another version or upgrade the current version. For more information on that, please have a look [here](https://thin-edge.github.io/thin-edge.io/html/howto-guides/002_installation.html#thin-edgeio-manual-installation) for more information.
It is possible to do the installation of thin-edge.io manually or install another version or upgrade the current version. For more information on that, please have a look [here](../install/) for more information.

After a successful installation, it is possible to use thin-edge.io via the CLI and use the tedge commands.

Expand Down Expand Up @@ -102,7 +102,7 @@ SUBCOMMANDS:
reconnect Reconnect command, calls disconnect followed by connect
```

Here is an [overview of the commands for the CLI tool](https://thin-edge.github.io/thin-edge.io/html/references/references.html).
Here is an [overview of the commands for the CLI tool](../references/cli/).

The CLI will be used to configure the thin-edge.io installation on the device in the next steps.

Expand Down Expand Up @@ -526,4 +526,4 @@ However, keep in mind that the daemon has to be restarted every time the `/etc/t

With this getting started tutorial you gained some insights on how to install and configure thin-edge.io on a Raspberry Pi.

If you didn't try the optional steps in this tutorial, it might be a nice idea to work on these as you then get a better insight into the device management capabilities of thin-edge.io. Other things you can work on are capabilities like working with child devices, building your own plugin etc. Tutorials for that can be found [here](https://thin-edge.github.io/thin-edge.io/html/).
If you didn't try the optional steps in this tutorial, it might be a nice idea to work on these as you then get a better insight into the device management capabilities of thin-edge.io. Other things you can work on are capabilities like working with child devices, building your own plugin etc. Tutorials for that can be found [here](../).

0 comments on commit da50f2e

Please sign in to comment.