From 69759c925a1c0cca556e619bb90424c8482f604e Mon Sep 17 00:00:00 2001 From: William Lyles <26171886+wilyle@users.noreply.github.com> Date: Tue, 20 Feb 2024 15:47:15 -0800 Subject: [PATCH] remove broken links --- cloud_connectors/azure/README.md | 10 ++++------ freyja_apps/e2e/README.md | 2 +- freyja_apps/template/README.md | 1 - 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/cloud_connectors/azure/README.md b/cloud_connectors/azure/README.md index 587cd16..85f98c8 100644 --- a/cloud_connectors/azure/README.md +++ b/cloud_connectors/azure/README.md @@ -2,7 +2,7 @@ The role of the Cloud Connector is to take the data emitted by Freyja, and update the data of your cloud digital twin which could be hosted in Azure, AWS, etc. -The [MQTT Connector](./mqtt_connector/README.md) and [Digital Twins Connector](./digital_twins_connector/README.md) are two sample implementations using Azure Digital Twins. +The [MQTT Connector](./mqtt_connector/README.md) is a sample implementation using MQTT and Azure Digital Twins. These two examples integrates Freyja with Azure Digital Twins. @@ -10,8 +10,6 @@ However, Freyja is not tightly coupled with Azure and can synchronize data with The [MQTT Connector](./mqtt_connector/README.md) relays the data emitted by Freyja to an [Azure Event Grid](https://learn.microsoft.com/en-us/azure/event-grid/overview) using the [MQTT](https://mqtt.org/) protocol. Data coming into the Event Grid will trigger an Azure function which updates the Azure Digital Twin instance. -The [Digital Twins Connector](./digital_twins_connector/README.md) updates an Azure Digital Twin instance directly with the data emitted by Freyja. - ## Prerequisites for Automated Deployment of Azure Resources The deployment scripts in the `{freyja-root-dir}/cloud_connectors/azure/scripts` directory will automate the deployment of necessary Azure resources depending on which Azure Cloud Connector sample you wish to use. @@ -20,7 +18,7 @@ The deployment scripts in the `{freyja-root-dir}/cloud_connectors/azure/scripts` To run the deployment scripts, you will need to complete each prerequisite section specified below. -Alternatively, you can create Azure resources via the Azure portal. Please see [Manual Azure Digital Twins Setup](./digital_twins_connector/README.md#manual-azure-digital-twins-setup) for the Digital Twins Connector sample, and [Manual Deployment of Azure Key Vault, Event Grid, and Azure Function App](./mqtt_connector/README.md#manual-deployment-of-azure-key-vault-event-grid-and-azure-function-app) for the MQTT Connector sample. +Alternatively, you can create Azure resources via the Azure portal. Please see [Manual Deployment of Azure Key Vault, Event Grid, and Azure Function App](./mqtt_connector/README.md#manual-deployment-of-azure-key-vault-event-grid-and-azure-function-app) for the MQTT Connector sample. ### Azure CLI and Extensions @@ -38,8 +36,8 @@ You will need to be an Owner for your Azure resource group to deploy Azure resou ## Automated Deployment of Azure Resources -Please see [Automated Azure Digital Twins Setup](./digital_twins_connector/README.md#automated-azure-digital-twins-setup) for the Digital Twins Connector sample, and [Automated Deployment of Azure Key Vault, Event Grid, and Azure Function App](./mqtt_connector/README.md#automated-deployment-of-azure-key-vault-event-grid-and-azure-function-app) for the MQTT Connector sample. +Please see [Automated Deployment of Azure Key Vault, Event Grid, and Azure Function App](./mqtt_connector/README.md#automated-deployment-of-azure-key-vault-event-grid-and-azure-function-app) for the MQTT Connector sample. If you experience permission or deployment errors, try running the script again as sometimes it takes a while for some dependencies to be fully deployed. If you use the same name or identifier for each Azure resource, the script will not create additional copies of that Azure resource. -You may also follow the [Manual Azure Digital Twins Setup](./digital_twins_connector/README.md#manual-azure-digital-twins-setup) for the Digital Twins Connector sample, or the [Manual Deployment of Azure Key Vault, Event Grid, and Azure Function App](./mqtt_connector/README.md#manual-deployment-of-azure-key-vault-event-grid-and-azure-function-app) for the MQTT Connector sample sections to deploy the respective Azure resource that is failing to be deployed by the script. +You may also follow the [Manual Deployment of Azure Key Vault, Event Grid, and Azure Function App](./mqtt_connector/README.md#manual-deployment-of-azure-key-vault-event-grid-and-azure-function-app) for the MQTT Connector sample sections to deploy the respective Azure resource that is failing to be deployed by the script. diff --git a/freyja_apps/e2e/README.md b/freyja_apps/e2e/README.md index 7b37dd7..1b87b5c 100644 --- a/freyja_apps/e2e/README.md +++ b/freyja_apps/e2e/README.md @@ -1,6 +1,6 @@ # End-To-End Freyja Example Application -This Freyja Example Application utilizes the [Ibeji Digital Twin Adapter](https://github.com/eclipse-ibeji/freyja/tree/main/adapters/digital_twin/ibeji_adapter/) and the [Azure Cloud Connector Adapter](../../freyja_adapters/cloud/azure_cloud_connector_adapter/) to show a minimal end-to-end example of how to sync data from the vehicle to the cloud. +This Freyja Example Application utilizes the [Ibeji Digital Twin Adapter](https://github.com/eclipse-ibeji/freyja/tree/main/adapters/digital_twin/ibeji_adapter/) and the [Standard GRPC Cloud Adapter](https://github.com/eclipse-ibeji/freyja/tree/main/adapters/cloud/grpc_cloud_adapter/) to show a minimal end-to-end example of how to sync data from the vehicle to the cloud. ## Build and Run diff --git a/freyja_apps/template/README.md b/freyja_apps/template/README.md index 46b555b..023c3b3 100644 --- a/freyja_apps/template/README.md +++ b/freyja_apps/template/README.md @@ -8,7 +8,6 @@ To create your own Freyja application, you can copy this template and make the f 1. Choose the adapters to use. Freyja requires users to select a Cloud Adapter, a Digital Twin Adapter, a Mapping Adapter, and at least one Data Adapter Factory. Some potential choices are: 1. Freyja mocks. These are enumerated [in the Freyja quickstart documentation](https://github.com/eclipse-ibeji/freyja/blob/main/docs/tutorials/quickstart.md#appendix-a) and are generally only suitable for tests or demos. - 1. [Example adapters from this repository](../../freyja_adapters/). 1. A custom adapter implementation. For more information on how to write and use these, see the see the [Freyja documentation on custom adapters](https://github.com/eclipse-ibeji/freyja/blob/main/docs/tutorials/custom-adapters.md). 1. Edit `Cargo.template.toml`: 1. Add dependencies for the package(s) you need for your adapters. You can implement adapters in the same crate and import their dependencies here, or you can implement them in separate crates and import those.