Skip to content

Commit a82f376

Browse files
authored
windturbine_anomaly_detection: Fixed the docs link (open-edge-platform#272)
Signed-off-by: Pooja Kumbharkar <pooja.kumbharkar@intel.com>
1 parent 041f75c commit a82f376

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

manufacturing-ai-suite/wind-turbine-anomaly-detection/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Wind Turbine Anomaly Detection sample application demonstrates a time series use
66

77
- **Overview**
88
- [Overview](docs/user-guide/Overview.md): A high-level introduction.
9-
- [Architecture](docs/user-guide/Overview.md#high-level-architecture): High Level Architecture.
9+
- [Architecture](docs/user-guide/how-it-works.md#high-level-architecture): High Level Architecture.
1010

1111
- **Getting Started**
1212
- [System Requirements](docs/user-guide/system-requirements.md): Hardware and software requirements for running the sample application.

manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/how-to-build-from-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide provides step-by-step instructions for building the `Time Series Analytics`
44
microservice and `Wind Turbine Anomaly Detection` Sample Application from source.
5-
Please follow [prerequisites](./get-started.md#prerequisites) and understand [data flow explanation](./get-started.md#data-flow-explanation)
5+
Please follow [prerequisites](./get-started.md#configure-docker) and understand [data flow explanation](./get-started.md#data-flow-explanation)
66
before proceeding with the below steps.
77

88
## Steps to Build from Source

manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/how-to-configure-alerts.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ curl -X 'POST' \
144144
145145
- **Publish MQTT Alerts**
146146
147-
For detailed instructions on configuring and publishing MQTT alerts, refer to the [Publishing MQTT Alerts](#publishing-mqtt-alerts) section.
147+
For detailed instructions on configuring and publishing MQTT alerts, refer to the [Publish MQTT Alerts](#publish-mqtt-alerts) section.
148148
149149
- **Subscribe to MQTT Alerts**
150150
@@ -181,7 +181,7 @@ To enable OPC-UA alerts in `Time Series Analytics Microservice`, please follow b
181181
182182
1. Configuring OPC-UA Alert in TICK Script
183183
184-
Configure the tick script by following [these instructions](#1-configuring-opc-ua-alert-in-tick-script).
184+
Configure the tick script by following [these instructions](#1-configure-opc-ua-alert-in-tick-script).
185185
186186
2. Copying the TICK script
187187
@@ -190,8 +190,8 @@ Copy the TICK script using the following command:
190190
```sh
191191
cd edge-ai-suites/manufacturing-ai-suite/wind-turbine-anomaly-detection # path relative to git clone folder
192192
cd time_series_analytics_microservice
193-
mkdir windturbine_anomaly_detector
194-
cp -r tick_scripts windturbine_anomaly_detector/.
193+
mkdir -p windturbine_anomaly_detector
194+
cp -r models tick_scripts udfs windturbine_anomaly_detector/.
195195
196196
POD_NAME=$(kubectl get pods -n ts-wind-turbine-anomaly-app -o jsonpath='{.items[*].metadata.name}' | tr ' ' '\n' | grep deployment-time-series-analytics-microservice | head -n 1)
197197
@@ -228,7 +228,7 @@ curl -X 'POST' \
228228
229229
- **Subscribe to OPC UA Alerts using Sample OPCUA Subscriber**
230230
231-
To subscribe to OPC-UA alerts, follow [these steps](#subscribing-to-opc-ua-alerts-using-sample-opcua-subscriber).
231+
To subscribe to OPC-UA alerts, follow [these steps](#subscribe-to-opc-ua-alerts-using-sample-opcua-subscriber).
232232
233233
## Supporting Resources
234234

manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/how-to-configure-custom-udf.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This guide provides instructions for setting up custom UDF deployment package (U
4444
- Key sections:
4545
- **Input**: Fetch data from Telegraf (stream).
4646
- **Processing**: Apply UDFs for analytics.
47-
- **Alerts**: Configuration for publishing alerts (e.g., MQTT). Refer [link](#Publishing-mqtt-alerts)
47+
- **Alerts**: Configuration for publishing alerts (e.g., MQTT). Refer [link](./how-to-configure-alerts.md#publish-mqtt-alerts)
4848
- **Logging**: Set log levels (`INFO`, `DEBUG`, `WARN`, `ERROR`).
4949
- **Output**: Publish processed data.
5050

@@ -69,7 +69,7 @@ and config.json has been volume mounted for the Time Series Analytics Microservi
6969

7070
1. Update the UDF deployment package by following the instructions in [Configure Time Series Analytics Microservice with Custom UDF Deployment Package](./how-to-configure-custom-udf.md#configure-time-series-analytics-microservice-with-custom-udf-deployment-package).
7171

72-
2. Copy the updated UDF deployment package using the [steps above](#copy-the-windturbine_anomaly_detection-udf-package-for-helm-deployment-to-time-series-analytics-microservice).
72+
2. Copy the updated UDF deployment package using the [steps](./how-to-deploy-with-helm.md#copy-the-windturbine_anomaly_detection-udf-package-for-helm-deployment-to-time-series-analytics-microservice).
7373

7474
3. Make the following REST API call to the Time Series Analytics microservice for the updated custom UDF:
7575
```sh

manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/how-to-enable-system-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> **Note**: The system metrics dashboard is only supported with docker compose deployments and requires `Telegraf` to run as the `root` user.
44
5-
Please follow [prerequisites](./get-started.md#prerequisites) and understand [data flow explanation](./get-started.md#data-flow-explanation) as
5+
Please follow [prerequisites](./get-started.md#configure-docker) and understand [data flow explanation](./get-started.md#data-flow-explanation) as
66
a prerequisite.
77

88
To enable the system metrics dashboard showcasing the host and docker containers CPU, memory, network, disk IO usage, run the following command:

manufacturing-ai-suite/wind-turbine-anomaly-detection/helm/values.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ env:
3131
# MR_PSQL_PASSWORD length must be a minimum of 10 alphanumeric characters with atleast one digit
3232
POSTGRES_PASSWORD:
3333

34-
# MR_MINIO_ACCESS_KEY length must be a minimum of 10 alphanumeric characters with atleast one digit
35-
MR_MINIO_ACCESS_KEY:
34+
# MINIO_ACCESS_KEY length must be a minimum of 10 alphanumeric characters with atleast one digit
35+
MINIO_ACCESS_KEY:
3636

37-
# MR_MINIO_SECRET_KEY length must be a minimum of 10 alphanumeric characters with atleast one digit
37+
# MINIO_SECRET_KEY length must be a minimum of 10 alphanumeric characters with atleast one digit
3838
MINIO_SECRET_KEY:
3939

4040
HTTP_PROXY:

0 commit comments

Comments
 (0)