Merge pull request #773 from davidebriani/forward-port-release-0.9-in…

…to-main

.github/workflows/docs-workflow.yaml

@@ -115,11 +115,9 @@ jobs:
     # Copy docs over to the docs repository
     - name: Copy Docs, preserving Device SDK docs
       run: |
-        export DOCS_DIRNAME="$(echo ${{ github.ref }} | sed 's,refs/heads/,,' | sed 's/main/snapshot/g' | sed 's/release-//g')"
+        export DOCS_DIRNAME="$(echo ${{ github.ref }} | sed 's,refs/heads/,,' | sed 's/main/snapshot/g' | sed 's/release-//g')"
         rm -rf docs/$DOCS_DIRNAME
         mkdir docs/$DOCS_DIRNAME
-        # Restore Device SDK docs. Don't fail if they're not there.
-        cd docs && git restore $DOCS_DIRNAME/device-sdks || true && cd ..
         # Copy doc pages
         cp -r edgehog/doc/doc/* docs/$DOCS_DIRNAME/
         # Copy version dropdown config
@@ -128,6 +126,15 @@ jobs:
         cp -r ./edgehog/backend/tenant-graphql-api docs/$DOCS_DIRNAME/
         # Copy Admin REST API docs
         cp -r ./edgehog/backend/admin-rest-api docs/$DOCS_DIRNAME/
+
+    # Upload as an artifact the generated HTML
+    - name: Upload HTML documentation
+      uses: actions/upload-artifact@v4
+      with:
+        name: docs_html
+        path: ./docs
+
+    # Commit and push changes to the docs repository
     - name: Commit files
       working-directory: ./docs
       run: |

doc/mix.exs

@@ -28,7 +28,7 @@ defmodule Doc.MixProject do
       elixir: "~> 1.15",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
-      name: "Edgehog",
+      name: "Clea Edgehog",
       homepage_url: "http://edgehog.io",
       docs: docs()
     ]
@@ -66,7 +66,7 @@ defmodule Doc.MixProject do
       "pages/user/hardware_types.md",
       "pages/user/system_models.md",
       "pages/user/devices.md",
-      "pages/user/device_sdks_runtime.md",
+      "pages/user/devices_and_runtime.md",
       "pages/user/attribute_value_sources.md",
       "pages/user/groups.md",
       "pages/user/batch_operations.md",

doc/pages/ota_updates/ota_updates.md

@@ -8,14 +8,14 @@
 
 Edgehog provides an OTA update mechanism that allows remotely updating devices. The OTA update
 mechanism is not tied to a specific platform and can be used on any [Edgehog
-runtime](device_sdks_runtime.html) which implements the
+runtime](devices_and_runtime.html) which implements the
 [`io.edgehog.devicemanager.OTARequest`](astarte_interfaces.html#io-edgehog-devicemanager-otarequest-v1-0),
 [`io.edgehog.devicemanager.OTAEvent`](astarte_interfaces.html#io-edgehog-devicemanager-otaevent-v0-1)
 and
 [`io.edgehog.devicemanager.BaseImage`](astarte_interfaces.html#io-edgehog-devicemanager-baseimage-v0-1)
 interfaces.
 
-OTA Update concepts are detailed in the [dedicated page](ota_update_concepts.html), this guide 
+OTA Update concepts are detailed in the [dedicated page](ota_update_concepts.html), this guide
 demonstrates the usage of an OTA update mechanism.
 
 ## Managed OTA Updates
@@ -24,7 +24,7 @@ Edgehog provides a mechanism to roll-out OTA updates to devices automatically, b
 Model](core_concepts.html#system-model) and their membership to specific [Groups](core_concepts.html#group).
 
 To push updates towards Devices, an Update Campaign must be created. It's important to note that an Update
-Campaign can only send updates for the same Base Image Collection. Special operations, such as 
+Campaign can only send updates for the same Base Image Collection. Special operations, such as
 converting a Device from one System Model to another, must always be done with a [Manual OTA
 Update](#manual-ota-updates).
 
@@ -42,7 +42,7 @@ Before actual push to the Device corresponding [Update Target](ota_update_concep
 is verified for fulfillment of Base Image and Roll-out mechanism criteria. For example:
 - Devices having same Base Image version will be silently marked as successful.
 - Devices with Base Images that don't meet [Version Requirement](ota_update_concepts.html#version-requirement)
-  of distributed Base Image will be marked as failed, unless the `Force Downgrade` option 
+  of distributed Base Image will be marked as failed, unless the `Force Downgrade` option
   of [Push Roll-out mechanism](update_campaigns.html#roll-out-mechanism) is enabled.
 
 ## Manual OTA Updates
@@ -51,7 +51,7 @@ As an escape hatch, it's always possible to manually update a [Device](core_conc
 from its page on the Edgehog dashboard (or using the Edgehog GraphQL API).
 
 Note that Manual OTA Updates do not perform any check on the [System Model](core_concepts.html#system-model),
-so they can effectively be used to change the System Model of a Device. This also means that the user 
+so they can effectively be used to change the System Model of a Device. This also means that the user
 must exercise particular attention to avoid bricking a Device, if the Device does not implement the necessary
 safety checks.
 

doc/pages/user/devices_and_runtime.md

@@ -0,0 +1,24 @@
+<!---
+  Copyright 2021,2022 SECO Mind Srl
+
+  SPDX-License-Identifier: Apache-2.0
+-->
+
+# Devices & runtime
+
+## Edgehog device for ESP32
+The Edgehog device for ESP32 is an
+[ESP-IDF component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html)
+written in C, that enables remote device management using Edgehog.
+You can find:
+* The source code and installation instructions in the
+  [GitHub page](https://github.com/edgehog-device-manager/edgehog-esp32-device).
+* The APIs for each version at the following links:
+  * [0.8](../devices/esp32/0.8/api/index.html).
+
+## Edgehog device runtime
+The Edgehog device runtime is a portable middleware written in Rust, that enables remote device
+management using Edgehog.
+You can find:
+* The source code and installation instructions in the
+  [GitHub page](https://github.com/edgehog-device-manager/edgehog-device-runtime).

frontend/index.html

@@ -1,7 +1,7 @@
 <!--
   This file is part of Edgehog.
 
-  Copyright 2021-2023 SECO Mind Srl
+  Copyright 2021-2024 SECO Mind Srl
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
     <meta name="description" content="Edgehog" />
+    <link rel="icon" href="/src/assets/images/logo.png" />
     <link rel="apple-touch-icon" href="/logo.png" />
     <link rel="manifest" href="/manifest.json" />
     <link

frontend/src/assets/images/brand.png.license

@@ -1,3 +1,3 @@
-SPDX-FileCopyrightText: 2021-2022 SECO Mind Srl
+SPDX-FileCopyrightText: 2021-2024 SECO Mind Srl
 
 SPDX-License-Identifier: Apache-2.0

frontend/src/assets/images/login_brand.png.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 SECO Mind Srl
+
+SPDX-License-Identifier: Apache-2.0

frontend/src/assets/index.ts

@@ -19,11 +19,13 @@
 */
 
 import brand from "assets/images/brand.png";
+import login_brand from "assets/images/login_brand.png";
 import logo from "assets/images/logo.png";
 
 const assets = {
   images: {
     brand,
+    login_brand,
     logo,
   },
 };

frontend/src/components/AuthPage.tsx

@@ -39,7 +39,7 @@ const AuthPage = ({ children }: AuthPageProps) => {
             lg={4}
             className="d-none d-lg-flex flex-column justify-content-center align-items-center border-end p-5"
           >
-            <Card.Img src={assets.images.brand} alt="Edgehog" />
+            <Card.Img src={assets.images.login_brand} alt="Edgehog" />
           </Col>
           <Col
             xs={12}