diff --git a/docs/develop/integrate-data/read-csv.md b/docs/develop/integrate-data/read-csv.md index f329ad08..746afa65 100644 --- a/docs/develop/integrate-data/read-csv.md +++ b/docs/develop/integrate-data/read-csv.md @@ -14,7 +14,7 @@ You'll need a streaming token to authenticate with Quix if you're going to run a In Quix Cloud, the streaming token is automatically set in the project environment. -Once you [get your streaming token]((../../develop/authentication/streaming-token.md)), you can subsequently load it from a suitable `.env` file: +Once you [get your streaming token](../../develop/authentication/streaming-token.md), you can subsequently load it from a suitable `.env` file: ``` Quix__Sdk__Token="" diff --git a/docs/tutorials/clickstream/overview.md b/docs/tutorials/clickstream/overview.md index d1ff21d3..c3e529eb 100644 --- a/docs/tutorials/clickstream/overview.md +++ b/docs/tutorials/clickstream/overview.md @@ -1,5 +1,9 @@ # Clickstream analysis +!!! warning + + This tutorial uses a template that is implemented with a deprecated version of Quix Streams (v0.5). For a tutorial that uses [Quix Streams v2](https://quix.io/docs/quix-streams/introduction.html) read the [InfluxDB alerting tutorial](../influxdb-alerting/overview.md). + In this tutorial you learn about a project template that analyzes a clickstream in real time, and generates events based on behavior. You use Python, rather than kSQL to perform aggregations and implement event logic based on user behavior. This tutorial uses the [Quix Clickstream analysis template project](https://github.com/quixio/template-clickstream){target=_blank}. diff --git a/docs/tutorials/computer-vision/overview.md b/docs/tutorials/computer-vision/overview.md index 3d51df24..4437c199 100644 --- a/docs/tutorials/computer-vision/overview.md +++ b/docs/tutorials/computer-vision/overview.md @@ -1,5 +1,9 @@ # Computer vision +!!! warning + + This tutorial uses a template that is implemented with a deprecated version of Quix Streams (v0.5). For a tutorial that uses [Quix Streams v2](https://quix.io/docs/quix-streams/introduction.html) read the [InfluxDB alerting tutorial](../influxdb-alerting/overview.md). + In this tutorial you learn about a real-time computer vision application, using a [Quix template project](https://github.com/quixio/computer-vision-demo){target=_blank}. ![Computer vision pipeline](../../images/project-templates/computer-vision-pipeline.png) diff --git a/docs/tutorials/currency-alerting/currency-alerting.md b/docs/tutorials/currency-alerting/currency-alerting.md index d89dd429..c26086bd 100644 --- a/docs/tutorials/currency-alerting/currency-alerting.md +++ b/docs/tutorials/currency-alerting/currency-alerting.md @@ -1,5 +1,9 @@ # Currency alerting +!!! warning + + This tutorial uses a template that is implemented with a deprecated version of Quix Streams (v0.5). For a tutorial that uses [Quix Streams v2](https://quix.io/docs/quix-streams/introduction.html) read the [InfluxDB alerting tutorial](../influxdb-alerting/overview.md). + In this tutorial you will learn how to build a real-time streaming pipeline that sends push notifications to your phone when the Bitcoin price reaches a certain threshold. ## Learning objectives diff --git a/docs/tutorials/data-science/overview.md b/docs/tutorials/data-science/overview.md index 32326420..5ae62534 100644 --- a/docs/tutorials/data-science/overview.md +++ b/docs/tutorials/data-science/overview.md @@ -1,5 +1,9 @@ # Real-time Machine Learning (ML) predictions +!!! warning + + This tutorial is out of date. + In this tutorial you will learn how to deploy a real-time **data science** application into a scalable self-maintained solution. You create a service that predicts bicycle availability in New York, by building the raw data ingestion pipelines, Extract Transform Load (ETL), and predictions. ## Aim diff --git a/docs/tutorials/data-stream-processing/data-stream-processing.md b/docs/tutorials/data-stream-processing/data-stream-processing.md index 1fc87c9b..f255c21d 100644 --- a/docs/tutorials/data-stream-processing/data-stream-processing.md +++ b/docs/tutorials/data-stream-processing/data-stream-processing.md @@ -1,5 +1,9 @@ # Build an Interactive, Realtime Experience +!!! warning + + This tutorial is out of date. + ## Aim This Data Streaming and Processing tutorial will help you build your own realtime interactive creation. diff --git a/docs/tutorials/event-detection/overview.md b/docs/tutorials/event-detection/overview.md index c6edea87..62b6ada7 100644 --- a/docs/tutorials/event-detection/overview.md +++ b/docs/tutorials/event-detection/overview.md @@ -1,5 +1,9 @@ # Real-time event detection +!!! warning + + This tutorial is out of date. + In this tutorial you learn how to build a real-time event detection pipeline. Events are simulated crashes or accidents that could occur while driving or cycling. You deploy a crash detection service to detect crashes in real time, and a UI to view the location of the incident. diff --git a/docs/tutorials/matlab/matlab-and-simulink.md b/docs/tutorials/matlab/matlab-and-simulink.md index 2b0a2d2a..77b510d2 100644 --- a/docs/tutorials/matlab/matlab-and-simulink.md +++ b/docs/tutorials/matlab/matlab-and-simulink.md @@ -1,5 +1,9 @@ # MATLAB and Simulink +!!! warning + + This tutorial uses a template that is implemented with a deprecated version of Quix Streams (v0.5). For a tutorial that uses [Quix Streams v2](https://quix.io/docs/quix-streams/introduction.html) read the [InfluxDB alerting tutorial](../influxdb-alerting/overview.md). + MATLAB and Simulink by MathWorks play an important role in scientific computing and Model-based Design in academic and industrial applications of science and technology. Ability to deploy MATLAB and Simulink applications with Quix enables engineers, scientists and researchers to develop, test, deploy and orchestrate large clusters of stream processing applications at scale. The following sections describe how to deploy MATLAB functions and Simulink models to Quix to perform real-time analytics and simulations with MATLAB and Quix Streams. diff --git a/docs/tutorials/overview.md b/docs/tutorials/overview.md index a03732de..744eb671 100644 --- a/docs/tutorials/overview.md +++ b/docs/tutorials/overview.md @@ -8,6 +8,35 @@ Some tutorials use [project templates](../get-started/project-templates.md) - th
+- __InfluxDB migration__ + + --- + + Migrate from InfluxDB v2 to v3 using Quix. + + [Explore :octicons-arrow-right-24:](../tutorials/influxdb-migration/overview.md) + +- __InfluxDB alerting__ + + --- + + InfluxDB event detection and alerting using PagerDuty. + + [Explore :octicons-arrow-right-24:](../tutorials/influxdb-alerting/overview.md) + +- __Vector Store Embeddings__ + + --- + + Stream data from a CSV (simulating CDC or "Change Data Capture") and ingest it into a vector store: for semantic search. + + [Explore :octicons-arrow-right-24:](../tutorials/ingest-embeddings/continuously_ingest_documents_into_a_vector_store_using_apache_kafka.md) + +
+ + ## Need help? diff --git a/docs/tutorials/predictive-maintenance/overview.md b/docs/tutorials/predictive-maintenance/overview.md index a06d00f4..810f28bc 100644 --- a/docs/tutorials/predictive-maintenance/overview.md +++ b/docs/tutorials/predictive-maintenance/overview.md @@ -1,5 +1,9 @@ # Predictive maintenance +!!! warning + + This tutorial uses a template that is implemented with a deprecated version of Quix Streams (v0.5). For a tutorial that uses [Quix Streams v2](https://quix.io/docs/quix-streams/introduction.html) read the [InfluxDB alerting tutorial](../influxdb-alerting/overview.md). + In this tutorial you learn about a project template that demonstrates real-time predictive analytics. It simulates three temperature sensors on a fleet of 3D printers. It predicts temperature for the printers using the `scikit-learn` library. This tutorial uses the [Quix predictive maintenance template project](https://github.com/quixio/template-predictive-maintenance){target=_blank}. diff --git a/docs/tutorials/rss-tutorial/rss-processing-pipeline.md b/docs/tutorials/rss-tutorial/rss-processing-pipeline.md index 22bfdc6c..4c77fb7a 100644 --- a/docs/tutorials/rss-tutorial/rss-processing-pipeline.md +++ b/docs/tutorials/rss-tutorial/rss-processing-pipeline.md @@ -1,5 +1,9 @@ # RSS Processing +!!! warning + + This tutorial is out of date. + ## RSS processing pipeline This tutorial explains how to build a pipeline that gathers and diff --git a/docs/tutorials/sentiment-analysis/overview.md b/docs/tutorials/sentiment-analysis/overview.md index 28c21c49..8a23cd4e 100644 --- a/docs/tutorials/sentiment-analysis/overview.md +++ b/docs/tutorials/sentiment-analysis/overview.md @@ -1,5 +1,9 @@ # Chat sentiment analysis +!!! warning + + This tutorial uses a template that is implemented with a deprecated version of Quix Streams (v0.5). For a tutorial that uses [Quix Streams v2](https://quix.io/docs/quix-streams/introduction.html) read the [InfluxDB alerting tutorial](../influxdb-alerting/overview.md). + In this tutorial you learn about a real-time chat sentiment analysis application, using a [Quix template project](https://github.com/quixio/chat-demo-app){target=_blank}. ![Sentiment analysis pipeline](../../images/project-templates/chat-sentiment-pipeline.png) diff --git a/docs/tutorials/slack-alerting/slack-alerting.md b/docs/tutorials/slack-alerting/slack-alerting.md index 4a8fbc20..e7f3120b 100644 --- a/docs/tutorials/slack-alerting/slack-alerting.md +++ b/docs/tutorials/slack-alerting/slack-alerting.md @@ -1,5 +1,9 @@ # Sending TFL BikePoint availability alerts to Slack +!!! warning + + This tutorial is out of date. + ## Aim In this tutorial you will learn how to use Quix to create event driven notifications in real-time. In this example we’ll connect to the Transport for London BikePoint API and send availability alerts to Slack using Slacks Webhooks. diff --git a/docs/tutorials/train-and-deploy-ml/overview.md b/docs/tutorials/train-and-deploy-ml/overview.md index 25d618f5..6753f857 100644 --- a/docs/tutorials/train-and-deploy-ml/overview.md +++ b/docs/tutorials/train-and-deploy-ml/overview.md @@ -1,5 +1,9 @@ # Real-time Machine Learning (ML) pipelines +!!! warning + + This tutorial uses a template that is implemented with a deprecated version of Quix Streams (v0.5). For a tutorial that uses [Quix Streams v2](https://quix.io/docs/quix-streams/introduction.html) read the [InfluxDB alerting tutorial](../influxdb-alerting/overview.md). + In this tutorial, you learn how to extract data from Quix to train your Machine Learning (ML) model in Jupyter Notebook. You then learn how to deploy this model to Quix, so ML can be used to process your data in real time. ## Video diff --git a/mkdocs.yml b/mkdocs.yml index a1abb6e9..8fe77151 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -24,7 +24,8 @@ nav: - '1. Ingest': 'get-started/quixtour/external-source.md' - '2. Process': 'get-started/quixtour/process-threshold.md' - '3. Serve': 'get-started/quixtour/serve-sms.md' - - 'Project templates': 'get-started/project-templates.md' +# Mostly out of date +# - 'Project templates': 'get-started/project-templates.md' - 'Quix CLI': 'get-started/cli.md' - 'Glossary': 'get-started/glossary.md' - 'Quix Streams': '!import https://github.com/quixio/quix-streams?branch=main' @@ -154,67 +155,67 @@ nav: - '9. Add PagerDuty alerting': 'tutorials/influxdb-alerting/add-alerting.md' - '10. Summary': 'tutorials/influxdb-alerting/summary.md' - 'Vector Store Embeddings': 'tutorials/ingest-embeddings/continuously_ingest_documents_into_a_vector_store_using_apache_kafka.md' - - 'Predictive maintenance': - - 'Overview': 'tutorials/predictive-maintenance/overview.md' - - '1. Get the project': 'tutorials/predictive-maintenance/get-project.md' - - '2. Data generator': 'tutorials/predictive-maintenance/data-generator.md' - - '3. Downsampling': 'tutorials/predictive-maintenance/downsampling.md' - - '4. Forecast': 'tutorials/predictive-maintenance/forecast-service.md' - - '5. Alerts': 'tutorials/predictive-maintenance/alert-service.md' - - '6. InfluxDB - raw data': 'tutorials/predictive-maintenance/influxdb-raw-data.md' - - '7. InfluxDB - alerts': 'tutorials/predictive-maintenance/influxdb-alerts.md' - - '8. Printers dashboard': 'tutorials/predictive-maintenance/printers-dashboard.md' - - '9. Lab: Add phone alerts': 'tutorials/predictive-maintenance/phone-alerts.md' - - '10. Summary': 'tutorials/predictive-maintenance/summary.md' - - 'Clickstream analysis': - - 'Overview': 'tutorials/clickstream/overview.md' - - '1. Get the project': 'tutorials/clickstream/get-project.md' - - '2. Clickstream producer': 'tutorials/clickstream/clickstream-producer.md' - - '3. Data ingestion': 'tutorials/clickstream/data-ingestion.md' - - '4. Data enrichment': 'tutorials/clickstream/data-enrichment.md' - - '5. Data aggregation': 'tutorials/clickstream/data-aggregation.md' - - '6. Event detection': 'tutorials/clickstream/event-detection.md' - - '7. Webshop frontend': 'tutorials/clickstream/webshop-frontend.md' - - '8. Real-time dashboard': 'tutorials/clickstream/realtime-dashboard.md' - - '9. Lab: change offer': 'tutorials/clickstream/change-offer.md' - - '10. Summary': 'tutorials/clickstream/summary.md' - - 'Computer vision': - - 'Overview': 'tutorials/computer-vision/overview.md' - - '1. Get the project': tutorials/computer-vision/get-project.md - - '2. TfL camera feed': tutorials/computer-vision/tfl-camera-feed.md - - '3. Frame grabber': tutorials/computer-vision/tfl-frame-grabber.md - - '4. Object detection': tutorials/computer-vision/object-detection.md - - '5. Web UI': tutorials/computer-vision/web-ui.md - - '6. Other services': tutorials/computer-vision/other-services.md - - '7. Add service': tutorials/computer-vision/add-service.md - - '8. Summary': tutorials/computer-vision/summary.md - - 'Chat sentiment analysis': - - 'Overview': 'tutorials/sentiment-analysis/overview.md' - - '1. Get the project': tutorials/sentiment-analysis/get-project.md - - '2. Try the UI': 'tutorials/sentiment-analysis/try-the-ui.md' - - '3. UI service': 'tutorials/sentiment-analysis/ui-service.md' - - '4. Sentiment analysis service': 'tutorials/sentiment-analysis/sentiment-analysis-service.md' - - '5. Twitch service': 'tutorials/sentiment-analysis/twitch-service.md' - - '6. Customize the UI': 'tutorials/sentiment-analysis/customize-the-ui.md' - - '7. Summary': 'tutorials/sentiment-analysis/summary.md' - - 'Real-time ML predictions': - - 'Overview': 'tutorials/data-science/overview.md' - - '1. Bicycle data': 'tutorials/data-science/1-bikedata.md' - - '2. Weather data': 'tutorials/data-science/2-weatherdata.md' - - '3. Data views': 'tutorials/data-science/3-data.md' - - '4. Get training data': 'tutorials/data-science/4-train.md' - - '5. Run the model': 'tutorials/data-science/5-run.md' - - '6. Conclusion': 'tutorials/data-science/6-conclusion.md' - - 'Real-time ML pipelines': - - 'Overview': 'tutorials/train-and-deploy-ml/overview.md' - - 'Create your data': 'tutorials/train-and-deploy-ml/create-data.md' - - 'Import data into Jupyter': 'tutorials/train-and-deploy-ml/import-data.md' - - 'Train your ML model': 'tutorials/train-and-deploy-ml/train-ml.md' - - 'Deploy your ML model': 'tutorials/train-and-deploy-ml/deploy-ml.md' - - 'Conclusion': 'tutorials/train-and-deploy-ml/conclusion.md' - - 'Currency Alerting': 'tutorials/currency-alerting/currency-alerting.md' - - 'MATLAB and Simulink': 'tutorials/matlab/matlab-and-simulink.md' - # These tutorials are commented out due to lack of updates / testing +# - 'Predictive maintenance': +# - 'Overview': 'tutorials/predictive-maintenance/overview.md' +# - '1. Get the project': 'tutorials/predictive-maintenance/get-project.md' +# - '2. Data generator': 'tutorials/predictive-maintenance/data-generator.md' +# - '3. Downsampling': 'tutorials/predictive-maintenance/downsampling.md' +# - '4. Forecast': 'tutorials/predictive-maintenance/forecast-service.md' +# - '5. Alerts': 'tutorials/predictive-maintenance/alert-service.md' +# - '6. InfluxDB - raw data': 'tutorials/predictive-maintenance/influxdb-raw-data.md' +# - '7. InfluxDB - alerts': 'tutorials/predictive-maintenance/influxdb-alerts.md' +# - '8. Printers dashboard': 'tutorials/predictive-maintenance/printers-dashboard.md' +# - '9. Lab: Add phone alerts': 'tutorials/predictive-maintenance/phone-alerts.md' +# - '10. Summary': 'tutorials/predictive-maintenance/summary.md' +# - 'Clickstream analysis': +# - 'Overview': 'tutorials/clickstream/overview.md' +# - '1. Get the project': 'tutorials/clickstream/get-project.md' +# - '2. Clickstream producer': 'tutorials/clickstream/clickstream-producer.md' +# - '3. Data ingestion': 'tutorials/clickstream/data-ingestion.md' +# - '4. Data enrichment': 'tutorials/clickstream/data-enrichment.md' +# - '5. Data aggregation': 'tutorials/clickstream/data-aggregation.md' +# - '6. Event detection': 'tutorials/clickstream/event-detection.md' +# - '7. Webshop frontend': 'tutorials/clickstream/webshop-frontend.md' +# - '8. Real-time dashboard': 'tutorials/clickstream/realtime-dashboard.md' +# - '9. Lab: change offer': 'tutorials/clickstream/change-offer.md' +# - '10. Summary': 'tutorials/clickstream/summary.md' +# - 'Computer vision': +# - 'Overview': 'tutorials/computer-vision/overview.md' +# - '1. Get the project': tutorials/computer-vision/get-project.md +# - '2. TfL camera feed': tutorials/computer-vision/tfl-camera-feed.md +# - '3. Frame grabber': tutorials/computer-vision/tfl-frame-grabber.md +# - '4. Object detection': tutorials/computer-vision/object-detection.md +# - '5. Web UI': tutorials/computer-vision/web-ui.md +# - '6. Other services': tutorials/computer-vision/other-services.md +# - '7. Add service': tutorials/computer-vision/add-service.md +# - '8. Summary': tutorials/computer-vision/summary.md +# - 'Chat sentiment analysis': +# - 'Overview': 'tutorials/sentiment-analysis/overview.md' +# - '1. Get the project': tutorials/sentiment-analysis/get-project.md +# - '2. Try the UI': 'tutorials/sentiment-analysis/try-the-ui.md' +# - '3. UI service': 'tutorials/sentiment-analysis/ui-service.md' +# - '4. Sentiment analysis service': 'tutorials/sentiment-analysis/sentiment-analysis-service.md' +# - '5. Twitch service': 'tutorials/sentiment-analysis/twitch-service.md' +# - '6. Customize the UI': 'tutorials/sentiment-analysis/customize-the-ui.md' +# - '7. Summary': 'tutorials/sentiment-analysis/summary.md' +# - 'Real-time ML predictions': +# - 'Overview': 'tutorials/data-science/overview.md' +# - '1. Bicycle data': 'tutorials/data-science/1-bikedata.md' +# - '2. Weather data': 'tutorials/data-science/2-weatherdata.md' +# - '3. Data views': 'tutorials/data-science/3-data.md' +# - '4. Get training data': 'tutorials/data-science/4-train.md' +# - '5. Run the model': 'tutorials/data-science/5-run.md' +# - '6. Conclusion': 'tutorials/data-science/6-conclusion.md' +# - 'Real-time ML pipelines': +# - 'Overview': 'tutorials/train-and-deploy-ml/overview.md' +# - 'Create your data': 'tutorials/train-and-deploy-ml/create-data.md' +# - 'Import data into Jupyter': 'tutorials/train-and-deploy-ml/import-data.md' +# - 'Train your ML model': 'tutorials/train-and-deploy-ml/train-ml.md' +# - 'Deploy your ML model': 'tutorials/train-and-deploy-ml/deploy-ml.md' +# - 'Conclusion': 'tutorials/train-and-deploy-ml/conclusion.md' +# - 'Currency Alerting': 'tutorials/currency-alerting/currency-alerting.md' + #- 'MATLAB and Simulink': 'tutorials/matlab/matlab-and-simulink.md' + # These tutorials are commented out due to lack of updates / testing - warning has been added to overview #- 'RSS Processing': 'tutorials/rss-tutorial/rss-processing-pipeline.md' #- 'Data Stream Processing': 'tutorials/data-stream-processing/data-stream-processing.md' #- 'Slack Alerting': 'tutorials/slack-alerting/slack-alerting.md'