Skip to content

Commit

Permalink
Update heading level for Concept guides (#55)
Browse files Browse the repository at this point in the history
* Update heading level for Concept guides

- update the heading level from h2 to h3, i.e. replace ## with ###

Signed-off-by: Trifonova Antonia <[email protected]>

* Update heading level for Concept guides

- update the config.toml to show headers from h1 to h6
- add custom toc.html to show headers with length grether then 100
- update the suite-connector.md to use headers h3 and h4

Signed-off-by: Trifonova Antonia <[email protected]>
  • Loading branch information
antoniyatrifonova authored Jul 21, 2022
1 parent 175cd7a commit 05f3bc3
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 6 deletions.
3 changes: 3 additions & 0 deletions web/site/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ anchor = "smart"
style = "autumn"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"
[markup.tableOfContents]
endLevel = 6
startLevel = 1

# Everything below this are Site Params

Expand Down
2 changes: 1 addition & 1 deletion web/site/content/docs/concepts/container-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Container management enables a lightweight standard runtime which is capable to

![Container management](/kanto/images/docs/concepts/container-management.png)

## How it works
### How it works

A container image packs the application executable along with all its needed dependencies into a single artifact that can be built by a tooling of choice.
The built image is made available for usage by being pushed to a container image registry where the runtime can refer it to.
Expand Down
2 changes: 1 addition & 1 deletion web/site/content/docs/concepts/file-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ File upload enables sending of files to a backend storage of choice. It can be u

![File upload](/kanto/images/docs/concepts/file-upload.png)

## How it works
### How it works

It's not always possible to inline all the data into exchanged messages. For example, large log files or large diagnostic files cannot be sent as a telemetry message. In such scenarios, file upload can assist enabling massive amount of data to be stored to the backend storage.

Expand Down
2 changes: 1 addition & 1 deletion web/site/content/docs/concepts/software-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Software update enables the deployment and management of various software artifa

![Software update](/kanto/images/docs/concepts/software-update.png)

## How it works
### How it works

When the install operation is received at the edge, the download process is initiated. Retrieving the artifacts will continue until they are stored at the edge or their size threshold is reached. If successful, the artifacts are validated for integrity and further processed by the configured script. It is responsible to apply the new software and finish the operation. A status report is announced on each step of the process enabling its transparent monitoring.

Expand Down
6 changes: 3 additions & 3 deletions web/site/content/docs/concepts/suite-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ Suite connector enables the remote connectivity to an IoT cloud ecosystem of cho

![Suite connector](/kanto/images/docs/concepts/suite-connector.png)

## How it works
### How it works

The suite connector plays a key role in two communication aspects - local and remote.

### Cloud connectivity
#### Cloud connectivity

To initiate its connection, the edge has to be manually or automatically provisioned. The result of this operation is different parameters and identifiers. Currently, suite connector supports MQTT transport as a connection-oriented and requiring less resources in comparison to AMQP. Once established, the connection is used as a channel to pass the edge telemetry and event messages. The IoT cloud can control the edge via commands and responses.

In case of a connection interruption, the suite connector will switch to offline mode. The message buffer mechanism will be activated to ensure that there is no data loss. Reconnect exponential backoff algorithm will be started to guarantee that no excessive load will be generated to the IoT cloud. All local applications are not affected and can continue to operate as normal. Once the remote connection is restored, all buffered messages will be sent and the edge will be fully restored to online mode.

### Local communication
#### Local communication

Ensuring that local applications are loosely coupled, Eclipse Hono™ MQTT definitions are in use. The event-driven local messages exchange is done via a MQTT message broker - Eclipse Mosquitto™. The suite connector takes the responsibility to forward these messages to the IoT cloud and vice versa.

Expand Down
7 changes: 7 additions & 0 deletions web/site/layouts/partials/toc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{{ if not .Params.notoc }}
{{ with .TableOfContents }}
{{ if ge (len .) 100 }}
<div class="td-toc">{{ . }}</div>
{{ end }}
{{ end }}
{{ end }}

0 comments on commit 05f3bc3

Please sign in to comment.