diff options
author | Rina Fujino <18257209+rina23q@users.noreply.github.com> | 2022-05-31 16:33:22 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-31 16:33:22 +0200 |
commit | a19b1e462287186c6cf357e0c8a794fbc2e93195 (patch) | |
tree | 600b04e597cc61ceda56a0b8b9a303e2fdac6cf2 /docs | |
parent | aacb5ff692e4ae0c6f70673e6aa9798b7d13cb71 (diff) |
Fix broken links of docs (#1162)
Signed-off-by: Rina Fujino <18257209+rina23q@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/src/001_overview.md | 8 | ||||
-rw-r--r-- | docs/src/SUMMARY.md | 8 | ||||
-rw-r--r-- | docs/src/architecture/architecture.md (renamed from docs/src/architecture/README.md) | 0 | ||||
-rw-r--r-- | docs/src/howto-guides/howto-guides.md (renamed from docs/src/howto-guides/README.md) | 0 | ||||
-rw-r--r-- | docs/src/references/plugin-api.md | 4 | ||||
-rw-r--r-- | docs/src/references/references.md (renamed from docs/src/references/README.md) | 0 | ||||
-rw-r--r-- | docs/src/tutorials/tutorials.md (renamed from docs/src/tutorials/README.md) | 0 |
7 files changed, 10 insertions, 10 deletions
diff --git a/docs/src/001_overview.md b/docs/src/001_overview.md index 95345fcb..070ebab9 100644 --- a/docs/src/001_overview.md +++ b/docs/src/001_overview.md @@ -21,7 +21,7 @@ say Rust or Python. ## Grow your skills -* Explore the [tutorials and use-cases](tutorials/README.md). -* Understand the [architecture](architecture/README.md). -* Use the [how-to guides](howto-guides/README.md) on a daily basis. -* Refer to the [reference guides](references/README.md) for any in-depth details. +* Explore the [tutorials and use-cases](tutorials/tutorials.md). +* Understand the [architecture](architecture/architecture.md). +* Use the [how-to guides](howto-guides/howto-guides.md) on a daily basis. +* Refer to the [reference guides](references/references.md) for any in-depth details. diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index ee34ca65..9c1603a4 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -6,7 +6,7 @@ - [User Documentation](user_doc.md) - - [Tutorials](tutorials/README.md) + - [Tutorials](tutorials/tutorials.md) - [Connect my device to Cumulocity IoT](./tutorials/connect-c8y.md) - [Connect my device to Azure IoT](./tutorials/connect-azure.md) @@ -18,7 +18,7 @@ - [Write my software management plugin](./tutorials/write-my-software-management-plugin.md) - [Supported Operations Management for Cumulocity IoT](./tutorials/supported_operations.md) - - [How-to Guides](howto-guides/README.md) + - [How-to Guides](howto-guides/howto-guides.md) - [Installation](howto-guides/002_installation.md) - [How to create a test certificate](./howto-guides/003_registration.md) - [How to connect a cloud end-point](./howto-guides/004_connect.md) @@ -45,7 +45,7 @@ - [Developer Documentation](dev_doc.md) - - [Architecture](architecture/README.md) + - [Architecture](architecture/architecture.md) - [Thin Edge Json](architecture/thin-edge-json.md) - [The Mapper](architecture/mapper.md) @@ -64,7 +64,7 @@ - [Building](./BUILDING.md) -- [Command Line Reference](references/README.md) +- [Command Line Reference](references/references.md) - [The `tedge` command](./references/tedge.md) - [The `tedge config` command](./references/tedge-config.md) - [The `tedge cert` command](./references/tedge-cert.md) diff --git a/docs/src/architecture/README.md b/docs/src/architecture/architecture.md index a559c272..a559c272 100644 --- a/docs/src/architecture/README.md +++ b/docs/src/architecture/architecture.md diff --git a/docs/src/howto-guides/README.md b/docs/src/howto-guides/howto-guides.md index 2dfc81c0..2dfc81c0 100644 --- a/docs/src/howto-guides/README.md +++ b/docs/src/howto-guides/howto-guides.md diff --git a/docs/src/references/plugin-api.md b/docs/src/references/plugin-api.md index 2c5733d5..aaea8be6 100644 --- a/docs/src/references/plugin-api.md +++ b/docs/src/references/plugin-api.md @@ -4,7 +4,7 @@ Thin-edge uses plugins to delegate to the appropriate package managers and insta all the software management operations: installation of packages, uninstallations and queries. * A package manager plugin acts as a facade for a specific package manager. -* A plugin is an executable that follows the [plugin API](./#plugin-api). +* A plugin is an executable that follows the [plugin API](#plugin-api). * On a device, several plugins can be installed to deal with different kinds of software modules. * The filename of a plugin is used by thin-edge to determine the appropriate plugin for a software module. * All the actions on a software module are directed to the plugin bearing the name that matches the module type name. @@ -29,7 +29,7 @@ all the software management operations: installation of packages, uninstallation On start-up and sighup, the sm-agent registers the plugins as follow: 1. Iterate over the executable file of the directory `/etc/tedge/sm-plugins`. -2. Check the executable is indeed a plugin, calling the [`list`](./#the_list_command) command. +2. Check the executable is indeed a plugin, calling the [`list`](#the-list-command) command. ## Plugin API diff --git a/docs/src/references/README.md b/docs/src/references/references.md index 4b2e6235..4b2e6235 100644 --- a/docs/src/references/README.md +++ b/docs/src/references/references.md diff --git a/docs/src/tutorials/README.md b/docs/src/tutorials/tutorials.md index 47a7da02..47a7da02 100644 --- a/docs/src/tutorials/README.md +++ b/docs/src/tutorials/tutorials.md |