### Install SignalR via npm Source: https://github.com/quixio/quix-docs/blob/main/docs/apis/streaming-writer-api/setup.md Installs the Microsoft SignalR library for Node.js applications using the npm package manager. ```shell npm install @microsoft/signalr ``` -------------------------------- ### Install SignalR via npm Source: https://github.com/quixio/quix-docs/blob/main/docs/apis/streaming-reader-api/setup.md Installs the Microsoft SignalR library for Node.js applications using the npm package manager. ```shell npm install @microsoft/signalr ``` -------------------------------- ### Complete Dockerfile with libgomp1 Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/event-detection/crash-detection.md The complete Dockerfile for the event detection service, including the installation of `libgomp1` and the setup for Python package installation. ```sh FROM quixpythonbaseimage ENV DEBIAN_FRONTEND="noninteractive" ENV PYTHONUNBUFFERED=1 ENV PYTHONIOENCODING=UTF-8 ENV SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt WORKDIR /app COPY --from=git /project . RUN apt-get -y install libgomp1 ca-certificates RUN find | grep requirements.txt | xargs -I '{}' python3 -m pip install -i http://pip-cache.pip-cache.svc.cluster.local/simple --trusted-host pip-cache.pip-cache.svc.cluster.local -r '{}' --extra-index-url https://pypi.org/simple --extra-index-url https://pkgs.dev.azure.com/quix-analytics/53f7fe95-59fe-4307-b479-2473b96de6d1/_packaging/public/pypi/simple/ ENTRYPOINT python3 main.py ``` -------------------------------- ### Install Quix Streams Source: https://github.com/quixio/quix-docs/blob/main/docs/get-started/welcome.md Start building your stream processing pipeline locally on the command line with Quix Streams. ```bash pip install quix-streams ``` -------------------------------- ### Tutorial and Guide Updates Source: https://github.com/quixio/quix-docs/wiki/Docs-Releases Documents changes to tutorials and guides, including updates to existing ones, removal of duplicates, and the addition of new content. This encompasses updates to CLI tutorials, Quickstart guides, and specific topic tutorials. ```markdown - Updates CLI Overview text - Updates CLI Quickstart - Removes build a pipeline tutorial for CLI as duplicated new CLI Quickstart - Updates Quix Quickstart to be a Cloud Quickstart - Updates Quix Tour and rename to Quix Cloud Tour - Make sure instructions on installing Quix Streams are more prominently displayed - Adds docs page on installing Quix Streams in Quix Cloud - Update CLI template tutorial to use new `quix local pipeline up/down` commands - Move CLI Quickstart to CLI section of docs - Add preprequisites to make sure users have both CLI and Quix Streams installed and updated - Change Quix Streams minimum version in examples to 2.4.2 - Update to writing style guide - Warning banners for tutorials - Warning banners for CLI - Improvements to CLI template tutorial - Adds docs page on using Quix CLI with GitHub Actions - Adds danger banner to *every* page in **outdated** tutorials - Slight change to nav order: put Quix Streams at higher level than CLI - Rename Tutorial to Quickstart in "Get started" section - Expand streaming concepts section - Update docs on how to deploy an application to include "latest and pinned" version feature. Also includes updated screenshots, tips, and using the Quix CLI. - Adds new tutorial for Quix CLI - Restructures Quix CLI material - Updates Quix CLI reference guide - Update predictive maintenance tutorial and add back into sidebar - Give Quix CLI its own section in the sidebar - Improve social card - Add extended CLI tutorial - Updates for latest version of Quix Streams * Update InfluxDB Quickstart and other docs as connectors moved to latest version of Quix Streams - Use navigation sections - Adds new Quix CLI tutorial - Adds concepts section - Restructure for command-line first approach * Move Quix Quickstart and Quix Tour to Cloud section * Move get started content to knowledge base * Adds new Install / Quickstart / Tutorial for Quix Streams on the command line - Update InfluxDB quickstart - Update code examples to latest version of Quix Streams - Replace Quix to JSON conversion with MessagePack to JSON - Fix favicon (white background when not focused) - Star us on GitHub now points to Quix Streams, not docs repo, and opens in new tab - Try for free opens in new tab - Adds metadata title and description for overview topics - Simplify event detection and alerting tutorial and improve code - Disabled old tutorials and tutorials based on templates that do not use Quix Streams v2 - Added InfluxDB migration guide - Added Quix as Kapacitor replacement topic ``` -------------------------------- ### InfluxDB Source Configuration Source: https://github.com/quixio/quix-docs/blob/main/docs/integrations/databases/influxdb/quickstart.md Configuration details for setting up InfluxDB as a source in Quix. This involves setting environment variables to query data from InfluxDB and publish it to a Quix topic. ```yaml input: influxdb INFLUXDB_HOST: https://us-east-1-1.aws.cloud2.influxdata.com/ INFLUXDB_TOKEN: "your-secret-token" INFLUXDB_ORG: Docs INFLUXDB_DATABASE: f1-data INFLUXDB_MEASUREMENT_NAME: f1-data task_interval: 1s ``` -------------------------------- ### InfluxDB 3.0 Connector API Source: https://github.com/quixio/quix-docs/blob/main/docs/integrations/databases/influxdb/quickstart.md API documentation for the InfluxDB 3.0 connector, detailing its configuration parameters and usage within the Quix platform. ```APIDOC InfluxDBConnector: __init__(topic: str, destination_topic: str = None, **kwargs): topic: The Quix topic to read data from. destination_topic: The Quix topic to write data to (for source connector). **kwargs: Environment variables for InfluxDB configuration. Parameters: input (str): The input topic name (for destination connector). INFLUXDB_HOST (str): The InfluxDB host URL. INFLUXDB_TOKEN (secret): The InfluxDB access token. INFLUXDB_ORG (str): The InfluxDB organization name. INFLUXDB_DATABASE (str): The InfluxDB bucket name. INFLUXDB_TAG_COLUMNS (list[str]): List of tag columns to use. INFLUXDB_FIELD_KEYS (list[str]): List of field keys to write. INFLUXDB_MEASUREMENT_NAME (str): The InfluxDB measurement name. CONSUMER_GROUP_NAME (str): The consumer group name for the connector. TIMESTAMP_COLUMN (str, optional): The field containing the timestamp. Defaults to message timestamp. task_interval (str, optional): The interval for querying data (for source connector). Defaults to '5s'. Example (Destination): influxdb_dest = InfluxDBConnector(topic='processed-telemetry', INFLUXDB_HOST='https://...', INFLUXDB_TOKEN='secret-token', INFLUXDB_ORG='my-org', INFLUXDB_DATABASE='my-bucket', INFLUXDB_MEASUREMENT_NAME='my-measurement') Example (Source): influxdb_source = InfluxDBConnector(topic='raw-data', destination_topic='influxdb-output', INFLUXDB_HOST='https://...', INFLUXDB_TOKEN='secret-token', INFLUXDB_ORG='my-org', INFLUXDB_DATABASE='my-bucket', INFLUXDB_MEASUREMENT_NAME='my-measurement', task_interval='1s') ``` -------------------------------- ### InfluxDB Destination Configuration Source: https://github.com/quixio/quix-docs/blob/main/docs/integrations/databases/influxdb/quickstart.md Configuration details for setting up InfluxDB as a destination in Quix. This includes required environment variables for connecting to InfluxDB and publishing data. ```yaml input: processed-telemetry INFLUXDB_HOST: https://us-east-1-1.aws.cloud2.influxdata.com/ INFLUXDB_TOKEN: "your-secret-token" INFLUXDB_ORG: Docs INFLUXDB_DATABASE: f1-data INFLUXDB_TAG_COLUMNS: ['tag1', 'tag2'] INFLUXDB_FIELD_KEYS: ['average-speed'] INFLUXDB_MEASUREMENT_NAME: f1-data CONSUMER_GROUP_NAME: influxdb-sink TIMESTAMP_COLUMN: "" ``` -------------------------------- ### Quix Tutorial Structure Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/clickstream/overview.md Outlines the different parts of a Quix tutorial, guiding users through project setup and feature exploration. ```APIDOC Tutorial Parts: 1. Get the project: Setup and running the project in a Quix account. 2. Clickstream producer: Exploration of the clickstream producer service. 3. Data ingestion: Loading products and users from JSON files into Redis Cloud. 4. Data enrichment: Enriching clickstream data with product category and user information. 5. Data aggregation: Performing data aggregations and storing state in RocksDB, then adding to Redis Cloud. 6. Event detection: Implementing a state machine for detecting offer conditions and tailoring offers. 7. Webshop frontend: The user interface for the online shop. 8. Real-time dashboard: A real-time dashboard implementation using Streamlit. 9. Lab: change offer: Customizing the event detection service. 10. Summary: Concluding part with a summary of work completed and next steps. ``` -------------------------------- ### .NET SDK Environment with MATLAB Runtime Installation Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/matlab/matlab-and-simulink.md This Dockerfile sets up a .NET SDK environment using a Microsoft base image. It installs base dependencies from a text file, configures X11 paths, and downloads, extracts, and installs the MATLAB Runtime. It also sets the LD_LIBRARY_PATH environment variable. ```dockerfile FROM mcr.microsoft.com/dotnet/sdk:6.0-jammy # MathWorks base dependencies ENV DEBIAN_FRONTEND="noninteractive" TZ="Etc/UTC" COPY --from=git /project/base-dependencies.txt /tmp/base-dependencies.txt RUN apt-get update && apt-get install --no-install-recommends -y `cat /tmp/base-dependencies.txt` \ && apt-get clean && apt-get -y autoremove && rm -rf /var/lib/apt/lists/* RUN [ -d /usr/share/X11/xkb ] || mkdir -p /usr/share/X11/xkb # MATLAB runtime WORKDIR /tmp RUN wget https://ssd.mathworks.com/supportfiles/downloads/R2023a/Release/2/deployment_files/installer/complete/glnxa64/MATLAB_Runtime_R2023a_Update_2_glnxa64.zip -O MATLAB_Runtime_R2023a_Update_2_glnxa64.zip \ && unzip MATLAB_Runtime_R2023a_Update_2_glnxa64.zip \ && ./install -agreeToLicense yes -destinationFolder /opt/matlab \ && rm -rf /tmp/* ENV LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:/opt/matlab/R2023a/runtime/glnxa64:/opt/matlab/R2023a/bin/glnxa64:/opt/matlab/R2023a/sys/os/glnxa64:/opt/matlab/R2023a/sys/opengl/lib/glnxa64" ``` -------------------------------- ### Environment Configuration Example Source: https://github.com/quixio/quix-docs/blob/main/docs/create/overview.md An example illustrating how different environments within a project can be configured with distinct Git branches and Kafka hosting options. ```markdown Let’s look at an example, Project Alpha, which has a Git repository hosted on Bitbucket: | Environment | Branch | Kafka Hosting | | ---|---|---| | Production | main | Confluent Cloud | | Staging | staging | Quix | | Develop | dev | Quix | You can see that while the project is hosted in Bitbucket, each environment can use a different Kafka hosting option as required for the use case. ``` -------------------------------- ### Broker Setup Guides Update Source: https://github.com/quixio/quix-docs/blob/main/changelogs/2023-archive.md The copies of broker setup guides have been updated. This ensures the guides are current and provide accurate instructions for setting up brokers. ```text Updated copies of broker setup guides ``` -------------------------------- ### Quix Project and Environment Setup Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/clickstream/overview.md This section details the steps for creating a new project in Quix, which typically corresponds to a Git repository. It also covers the creation of environments, such as 'production', and their association with Git branches (e.g., 'main'). Branch protection for production environments is also highlighted to enforce pull request workflows. ```APIDOC Project Creation: - Name: Specify a name for your project (e.g., "video project"). - Git Repository: - Option 1: Let Quix create and host the Git repository (e.g., using Gitea). - Option 2: Use an external Git provider (GitHub, GitLab, Bitbucket) that supports SSH keys. Environment Setup: - Environment Name: Define an environment name (e.g., "production"). - Branch Mapping: - Associate the environment with a Git branch (e.g., "production" environment maps to the "main" branch). - Option to create a new branch or use an existing default branch. - Branch Protection: - Enable protection for the environment's branch (e.g., "main") to prevent direct commits/merges. - Changes must go through pull requests, reviews, and merges. Kafka Hosting Options: - Option 1: Let Quix manage Kafka hosting (simplest, auto-scaling). - Option 2: Use self-hosted Kafka. - Option 3: Connect to Confluent Cloud. ``` -------------------------------- ### Cloning Repository and Initial Setup Source: https://github.com/quixio/quix-docs/blob/main/RUNNING-DOCS-LOCALLY.md Clones the Quix documentation repository and makes the browser script executable. This is the first step to running the documentation locally. ```bash git clone https://github.com/quixio/quix-docs.git cd quix-docs chmod +x open-browser.sh ``` -------------------------------- ### MATLAB and Simulink Tutorial Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/overview.md This tutorial explains how to deploy real-time MATLAB transformations and Simulink models to Quix, enabling integration of these tools within the Quix platform. ```markdown - __MATLAB and Simulink__ --- Deploy real-time MATLAB transformations and Simulink models to Quix. [Explore :octicons-arrow-right-24:](../tutorials/matlab/matlab-and-simulink.md) ``` -------------------------------- ### Parentheses Usage - Avoidance Example Source: https://github.com/quixio/quix-docs/blob/main/WRITING-STYLE.md Shows an example of how to refactor sentences with embedded parentheses to improve readability, breaking them into lists or separate sentences. ```text You can implement this in JavaScript (or Python using the Python client library (otherwise known as the SDK)), or C# (with the .NET runtime). Better: You can implement your widget with: * JavaScript * Python using the Python client library * C# .NET **Note:** Libraries are sometimes referred to as SDKs. ``` -------------------------------- ### Train and deploy ML Tutorial Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/overview.md This tutorial guides users on extracting data from Quix to train Machine Learning (ML) models in Jupyter Notebook and subsequently deploying these solutions within Quix. ```markdown - __Train and deploy machine learning (ML)__ --- Extract data from Quix to train your Machine Learning (ML) model in Jupyter Notebook, then deploy your solution in Quix. [Explore :octicons-arrow-right-24:](../tutorials/train-and-deploy-ml/overview.md) ``` -------------------------------- ### BYOC Installation Improvements Source: https://github.com/quixio/quix-docs/blob/main/changelogs/2023-archive.md Several improvements have been made for Bring Your Own Cloud (BYOC) installations. These enhancements aim to streamline the BYOC setup and management process. ```text Several improvements for BYOC installations ``` -------------------------------- ### Active vs. Passive Voice Examples Source: https://github.com/quixio/quix-docs/blob/main/WRITING-STYLE.md Illustrates the preference for active voice in technical writing for directness and clarity, showing examples of both active and passive constructions. ```text *Active voice:* The man ate the apple. *Passive voice:* The apple was eaten by the man. *Active voice:* The client creates the connection. *Passive voice:* The connection is created by the client. *Active voice:* Quix provides a Python client library. *Passive voice:* A Python client library is provided by Quix. ``` -------------------------------- ### Python Environment Setup with Pip Configuration Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/matlab/matlab-and-simulink.md This Dockerfile snippet configures a Python environment, disabling bytecode writing and installing specific versions of pip and setuptools. It also includes commands to clean up the installation files. ```dockerfile export PYTHONDONTWRITEBYTECODE=1; \ \ python get-pip.py \ --disable-pip-version-check \ --no-cache-dir \ --no-compile \ "pip==$PYTHON_PIP_VERSION" \ "setuptools==$PYTHON_SETUPTOOLS_VERSION" \ ; \ rm -f get-pip.py; \ \ pip --version ``` -------------------------------- ### Quix Setup Guide for Confluent Cloud Source: https://github.com/quixio/quix-docs/blob/main/docs/integrations/brokers/confluent.md This section provides a step-by-step guide on how to set up the connection between Quix and Confluent Cloud. It covers obtaining API keys and secrets, as well as cluster connection details from the Confluent Cloud Console. ```APIDOC Confluent Cloud Setup: 1. Obtain API Key and Secret: - Navigate to 'Data integration' > 'API keys' in Confluent Cloud. - Click 'Add key' > 'Global access' > 'Next'. - Copy the generated API key and API secret. 2. Obtain Cluster Connection Details: - Navigate to 'Cluster Overview' > 'Cluster Settings' in Confluent Cloud. - Copy the Cluster ID, Bootstrap server, and REST endpoint. 3. Configure Quix: - Input the copied credentials and connection details into the Quix 'Connect your managed broker' dialog. - Click 'Test Connection' to verify the setup. ``` -------------------------------- ### Node.js Web API Hosting Source: https://github.com/quixio/quix-docs/blob/main/docs/deploy/deploy-public-page.md Example of how to run a Node.js web server, often used for Dash/Plotly apps or JavaScript websites, ensuring it's accessible on all network interfaces and port 80. ```js app.run_server(debug=False, host="0.0.0.0", port=80) ``` -------------------------------- ### Quix Streams Updates Source: https://github.com/quixio/quix-docs/wiki/Docs-Releases Details changes related to Quix Streams, including version updates, connector changes, and modifications to examples and tutorials to reflect the latest Quix Streams versions. This includes changes to InfluxDB Quickstart and code examples. ```markdown - Updates Quix Quickstart to be a Cloud Quickstart - Updates Quix Tour and rename to Quix Cloud Tour - Adds new Vector Databases section - Removes references to binary data in APIs and SDK - Remove cloud option on welcome page to force local-first approach - Remove "Try for free" button to force local-first approach - Make sure instructions on installing Quix Streams are more prominently displayed - Adds docs page on installing Quix Streams in Quix Cloud - Add preprequisites to make sure users have both CLI and Quix Streams installed and updated - Change Quix Streams minimum version in examples to 2.4.2 - Update predictive maintenance tutorial and add back into sidebar - Updates for latest version of Quix Streams * Update InfluxDB Quickstart and other docs as connectors moved to latest version of Quix Streams - Move Quix Quickstart and Quix Tour to Cloud section - Move get started content to knowledge base - Adds new Install / Quickstart / Tutorial for Quix Streams on the command line - Update InfluxDB quickstart - Update code examples to latest version of Quix Streams - Replace Quix to JSON conversion with MessagePack to JSON - Star us on GitHub now points to Quix Streams, not docs repo, and opens in new tab - Try for free opens in new tab - Disabled old tutorials and tutorials based on templates that do not use Quix Streams v2 - Added InfluxDB migration guide - Added Quix as Kapacitor replacement topic ``` -------------------------------- ### Quix Project Creation Workflow Source: https://github.com/quixio/quix-docs/blob/main/docs/create/create-project.md This documentation details the steps involved in creating a new project in Quix. It covers naming the project, selecting a Git repository host (Quix-managed or external), defining environments, and configuring Kafka hosting. ```APIDOC Project Creation: 1. Create New Project Button: Initiate the project creation process. 2. Project Naming: Assign a name to your project (e.g., "video project"). 3. Git Repository Management: - Quix Managed Git: Allows Quix to create and host the Git repository. - External Provider: Supports hosting on GitLab, GitHub, Bitbucket, etc., using SSH keys. 4. Environment Setup: - Environment Naming: Define names for environments (e.g., "production"). - Branch Mapping: Associate environments with Git branches (e.g., "production" to "main"). - Branch Protection: Option to protect branches, requiring pull requests for changes. 5. Kafka Hosting: - Quix Managed Kafka: Simplest option where Quix handles Kafka broker creation and scaling. - Self-Hosted Kafka: Use your own Kafka instance. - Confluent Cloud: Connect to Confluent Cloud. 6. Storage Options: Specify storage configurations for the environment. ``` -------------------------------- ### Full quix.yaml Example with Variables Source: https://github.com/quixio/quix-docs/blob/main/docs/deploy/yaml-variables.md A comprehensive example of a `quix.yaml` file showcasing the use of various YAML variables for resource allocation (CPU, memory, replicas), deployment status, and public access configuration. It also includes variable definitions for input and output topics. ```yaml # Quix Project Descriptor # This file describes the data pipeline and configuration of resources of a Quix Project. metadata: version: 1.0 # This section describes the Deployments of the data pipeline deployments: - name: CPU Threshold application: Starter transformation deploymentType: Service version: transform-v2 resources: cpu: {{CPU}} memory: {{MEMORY}} replicas: {{REPLICAS}} desiredStatus: Stopped disabled: {{DISABLED}} publicAccess: enabled: true urlPrefix: {{URL_PREFIX}}-{{ENV_NAME}} variables: - name: input inputType: InputTopic description: Name of the input topic to listen to. required: false value: cpu-load - name: output inputType: OutputTopic description: Name of the output topic to write to. required: false value: transform ``` -------------------------------- ### Number Formatting Example Source: https://github.com/quixio/quix-docs/blob/main/WRITING-STYLE.md Demonstrates consistent number formatting in tables for clarity and readability, adhering to style guidelines. ```text | Key | Value | |---|---| | A| 1000 | | B | 2 | | C | 50000 | ``` -------------------------------- ### Starting Documentation Server Source: https://github.com/quixio/quix-docs/blob/main/RUNNING-DOCS-LOCALLY.md Starts the Quix documentation server using Docker Compose and automatically opens it in the default browser. Supports both foreground and detached modes. ```bash docker compose up --build & ./open-browser.sh ``` ```bash docker compose up -d --build && ./open-browser.sh ``` -------------------------------- ### Clickstream analysis Tutorial Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/overview.md This tutorial covers clickstream analysis for online shop data, featuring a real-time dashboard and web shop user interface. It utilizes a project template for the clickstream analysis pipeline. ```markdown - __Clickstream analysis__ --- ![Clickstream analysis pipeline](../images/project-templates/clickstream-analysis-pipeline.png) `Project template` Clickstream analysis for online shop data. Features real-time dashboard and web shop user interface. [Explore :octicons-arrow-right-24:](../tutorials/clickstream/overview.md) ``` -------------------------------- ### Python Module Not Found Example Source: https://github.com/quixio/quix-docs/blob/main/docs/manage/troubleshooting.md Illustrates a common Python error, `ModuleNotFoundError`, which can occur if the correct Python version or the Quix client library is not installed. ```python ModuleNotFoundError: No module named 'quixstreams' ``` -------------------------------- ### Quix Project and Environment Creation Source: https://github.com/quixio/quix-docs/blob/main/docs/create/fork-project.md Steps for creating a new project in Quix, which involves connecting to a Git repository and setting up at least one environment. Environments are linked to branches and define storage and streaming capabilities. ```APIDOC Project Creation: - Connect to a Git repository (e.g., GitHub). - Configure public keys for the repository. Environment Creation: - Environment Name: A user-defined name for the environment (e.g., 'tutorial'). - Branch Selection: Choose a branch from the connected Git repository (e.g., 'tutorial'). - Protected Branch: Option to designate the branch as protected. - Kafka Broker: Option to use Quix broker or external services (Red Panda, Confluent Cloud). - Service Tier: Choose between 'Standard Data and String Services' or 'High Performance'. - Standard: Suitable for tutorials and general use. - High Performance: Recommended for heavy-duty production environments or when services are slow. - Sync Environment: Synchronize the Quix environment configuration with the Git repository. ``` -------------------------------- ### Run Jupyter Notebook Source: https://github.com/quixio/quix-docs/blob/main/docs/develop/integrate-data/jupyter-nb.md This command starts the Jupyter Notebook server. Ensure you have Jupyter Notebook installed in your Python environment. ```shell jupyter notebook ``` -------------------------------- ### Quix API Reference URLs Source: https://github.com/quixio/quix-docs/blob/main/docs/apis/streaming-writer-api/setup.md Provides the URLs for accessing the Swagger documentation for various Quix APIs. Users need to replace '' with their specific environment ID for most services. ```APIDOC Streaming Writer: URL: https://writer-.platform.quix.io/swagger Streaming Reader: Interface: SignalR (WebSockets or Long Polling) Note: No HTTP/REST interface available. Portal: URL: https://portal-api.platform.quix.io/swagger Query: URL: https://telemetry-query-.platform.quix.io/swagger ``` -------------------------------- ### Configuration and Environment Management Source: https://github.com/quixio/quix-docs/wiki/Docs-Releases This entry covers updates related to broker settings and the process of creating an environment, including interlinking with setup guides. ```markdown * Updates brokers settings * Updates brokers settings section in 'Create environment' topic, and interlinks with setup guides in Integrations * Adds create environment how-to ``` -------------------------------- ### Run Jupyter Notebook Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/train-and-deploy-ml/import-data.md Command to start the Jupyter Notebook server. Ensure Jupyter Notebook is installed in your Python environment. ```shell jupyter notebook ``` -------------------------------- ### Quix Free Account Setup Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/predictive-maintenance/overview.md Details on how to obtain a free Quix Cloud account, which is a prerequisite for trying out the project. It also mentions booking a demo session for assistance. ```APIDOC Quix Account: Type: Free Cloud Account Setup: Book a demo session for assistance and to start for free. Link: https://quix.io/book-a-demo ``` -------------------------------- ### Quix API Reference URLs Source: https://github.com/quixio/quix-docs/blob/main/docs/apis/portal-api/setup.md Provides the base URLs for accessing the Swagger documentation for various Quix APIs. Users need to replace `` with their specific environment ID. ```APIDOC Streaming Writer: URL: https://writer-.platform.quix.io/swagger Streaming Reader: Note: No HTTP/REST interface - uses SignalR (WebSockets or Long Polling). Portal: URL: https://portal-api.platform.quix.io/swagger Query: URL: https://telemetry-query-.platform.quix.io/swagger ``` -------------------------------- ### Vague Language Avoidance Example Source: https://github.com/quixio/quix-docs/blob/main/WRITING-STYLE.md Contrasts vague and cautious language with direct and confident phrasing, demonstrating how to improve clarity and inspire confidence. ```text *Avoid:* When an inbound message arrives, you might receive it, or you might get an error, or something! *Better:* When an inbound message arrives, the message callback handler is invoked. *Avoid:* If you click the button, the alert box will probably be displayed. *Better:* Click the `Submit` button, the alert box is displayed. ``` -------------------------------- ### Deploy Event Detection Demo UI Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/event-detection/crash-detection-ui.md Steps to deploy the prebuilt 'Event Detection Demo UI' from Code Samples. This involves searching for the UI, clicking deploy, and configuring input topics for sensor data and events. ```APIDOC Deploy UI: 1. Navigate to `Code Samples` and search for `Event Detection Demo UI`. 2. Click the `Deploy` button. 3. Configure `topic` input to `phone-data` (for sensor data). 4. Configure `eventTopic` input to `phone-out` (for crash events). 5. Click `Deploy` and wait for the UI to start. 6. Access the UI via the 'open in new window' button on its tile. UI Observation: - Map displaying device location. - Telemetry data from the device. - Timestamp of crash events, clickable to show location on map. Prerequisites: - Data streaming into the `phone-data` topic. - Services deployed in previous tutorial stages are running. - Phone data source (or CSV data source) is active. ``` -------------------------------- ### Computer vision Tutorial Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/overview.md This tutorial covers real-time computer vision using TfL's JamCams. It utilizes a project template for setting up the computer vision pipeline. ```markdown - __Computer vision__ --- ![Computer vision pipeline](../images/project-templates/computer-vision-pipeline.png) `Project template` Real-time computer vision using TfL's JamCams. [Explore :octicons-arrow-right-24:](../tutorials/computer-vision/overview.md) ``` -------------------------------- ### InfluxDB migration Tutorial Source: https://github.com/quixio/quix-docs/blob/main/docs/tutorials/overview.md This tutorial focuses on migrating data from InfluxDB v2 to v3 using Quix. It provides a step-by-step process for a smooth transition. ```markdown - __InfluxDB migration__ --- Migrate from InfluxDB v2 to v3 using Quix. [Explore :octicons-arrow-right-24:](../tutorials/influxdb-migration/overview.md) ``` -------------------------------- ### Substitution Prompt Formatting Source: https://github.com/quixio/quix-docs/blob/main/WRITING-STYLE.md Details the convention for indicating placeholders or required user input within code examples. Substitution prompts should be enclosed in angle brackets. ```markdown When substitutions are required in code blocks, such as requiring the reader to write their own API key, write the text prompt enclosed in a less than sign and a greater than sign. For example: ``. Except for proper nouns and acronyms, use lower case. ``` -------------------------------- ### Second Person Usage Examples Source: https://github.com/quixio/quix-docs/blob/main/WRITING-STYLE.md Demonstrates the use of the second person ('you') for direct instructions to the developer, contrasting it with less clear phrasing using 'we'. ```text *Avoid:* We now configure the inbound connector. *Better:* Enter your API Key in the `Setup & deploy` form. *Avoid:* We can now click the button to create your free Quix account. *Better:* You can now click the button to create your free Quix account. *Best:* Click the `Create` button to create your free Quix account. *Avoid:* We also provide a Python client library. *Better:* Quix also provides a Python client library. ```