quixio · tbedford · May 22, 2024 · May 13, 2024 · May 13, 2024 · May 13, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ This is the Quix Cloud changelog for the current year.
 
 See [here](https://github.com/quixio/quix-docs/wiki/Docs-Releases) for the docs changelog.
 
+## 2024-05-02-cli-beta-hf | 21 MAY 2024
+
+`BUG FIXES`
+
+- Users were unable to sign up for serverless plans
+
 ## 2024-05-01-cli-beta | 15 MAY 2024
 
 `NEW FEATURES`

diff --git a/RUNNING-DOCS-LOCALLY.md b/RUNNING-DOCS-LOCALLY.md
@@ -39,5 +39,5 @@ To view the docs locally:
    git clone https://github.com/quixio/quix-docs.git
    ```
 3. Change into the docs directory you cloned (there will be a `mkdocs.yml` file there). 
-4. Run `mkdocs serve`.
+4. Run `mkdocs serve --no-directory-urls`.
 5. Navigate your browser to `localhost:8000` to view the docs.
diff --git a/docs/apis/portal-api/setup.md b/docs/apis/portal-api/setup.md
@@ -36,7 +36,7 @@ To obtain a PAT, log in to Quix, and click on your profile icon in the top right
 
 Alternatively, log in to Quix, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`.
 
-In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token for use with the Quix Streams client library.
+In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token (SDK Token) for use with the Quix Streams client library.
 
 ## Get environment ID
 

diff --git a/docs/apis/query-api/aggregate-tags.md b/docs/apis/query-api/aggregate-tags.md
@@ -69,7 +69,6 @@ Standard aggregation functions are provided including `max`, `count`, and `sprea
     ]
   },
   "stringValues": {},
-  "binaryValues": {},
   "tagValues": {
     "LapNumber": [
       "3.0",

diff --git a/docs/apis/query-api/raw-data.md b/docs/apis/query-api/raw-data.md
@@ -20,7 +20,7 @@ You can filter by a number of different factors but, at minimum, you’ll need t
 }
 ```
 
-In this example, we’re requesting a single numeric parameter, `Speed`. Each array of parameters is indexed based on parameter type, which can be `numericParameters`, `stringParameters` or `binaryParameters`. Parameters are returned in a union, so if you request several, you’ll get back all parameters that match.
+In this example, we’re requesting a single numeric parameter, `Speed`. Each array of parameters is indexed based on parameter type, which can be `numericParameters` or `stringParameters`. Parameters are returned in a union, so if you request several, you’ll get back all parameters that match.
 
 ### Example
 
@@ -45,7 +45,6 @@ If you just had a single parameter value in the stored data, the response from t
         ]
     },
     "stringValues": {},
-    "binaryValues": {},
     "tagValues": {},
 }
 ```

diff --git a/docs/apis/query-api/setup.md b/docs/apis/query-api/setup.md
@@ -36,7 +36,7 @@ To obtain a PAT, log in to Quix, and click on your profile icon in the top right
 
 Alternatively, log in to Quix, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`.
 
-In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token for use with the Quix Streams client library.
+In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token (SDK Token) for use with the Quix Streams client library.
 
 ## Get environment ID
 

diff --git a/docs/apis/streaming-reader-api/setup.md b/docs/apis/streaming-reader-api/setup.md
@@ -36,7 +36,7 @@ To obtain a PAT, log in to Quix, and click on your profile icon in the top right
 
 Alternatively, log in to Quix, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`.
 
-In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token for use with the Quix Streams client library.
+In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token (SDK Token) for use with the Quix Streams client library.
 
 ## Get environment ID
 

diff --git a/docs/apis/streaming-writer-api/send-data.md b/docs/apis/streaming-writer-api/send-data.md
@@ -22,14 +22,13 @@ You should replace `${topicName}` with the name of the topic your stream belongs
 
 ### Example request
 
-Your payload should include an array of `timestamps` with one timestamp for each item of data you’re sending. Actual data values should be keyed on their name, in the object that corresponds to their type, one of `numericValues`, `stringValues`, or `binaryValues`. The payload is in this structure:
+Your payload should include an array of `timestamps` with one timestamp for each item of data you’re sending. Actual data values should be keyed on their name, in the object that corresponds to their type, one of `numericValues` or `stringValues`. The payload is in this structure:
 
 ```json
 {
     "timestamps": [...],
     "numericValues": {...},
     "stringValues": {...},
-    "binaryValues": {...},
     "tagValues": {...}
 }
 ```
@@ -130,13 +129,6 @@ connection.start().then(async () => {
           "!"
         ]
       },
-      "binaryValues": {
-        "BinaryParameter1": [
-          btoa("Hello"), // send binary array as base64
-          btoa("World"),
-          btoa("!")
-        ]
-      },
       "tagValues": {
         "Tag1": [
           "A",

diff --git a/docs/apis/streaming-writer-api/setup.md b/docs/apis/streaming-writer-api/setup.md
@@ -36,7 +36,7 @@ To obtain a PAT, log in to Quix, and click on your profile icon in the top right
 
 Alternatively, log in to Quix, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`.
 
-In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token for use with the Quix Streams client library.
+In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token (SDK Token) for use with the Quix Streams client library.
 
 ## Get environment ID
 

diff --git a/docs/develop/authentication/personal-access-token.md b/docs/develop/authentication/personal-access-token.md
@@ -6,4 +6,4 @@ To obtain a PAT, log in to Quix, and click on your profile icon in the top right
 
 Alternatively, log in to Quix, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`.
 
-In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token for use with the Quix Streams client library.
+In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token (SDK Token) for use with the Quix Streams client library.
diff --git a/docs/develop/authentication/streaming-token.md b/docs/develop/authentication/streaming-token.md
@@ -8,25 +8,25 @@ A streaming token is a type of bearer token that can be used to authenticate you
 
 As streaming tokens are scoped to a specific environment, it means you can specify a topic name, even if that same topic name is used across multiple environments. This is because the topic ID is automatically used for you, based on the streaming token used. For example, if you had a topic called `f1-data` in production and development environments, you could simply use the topic name of `f1-data` in your code, regardless of the environment you're connecting to. In production, the topic ID might be `orgname-projectname-prod-f1-data`, and in development it might be `orgname-projectname-dev-f1-data`, however, the correct topic ID is automatically used by Quix Streams, as the environment is identified in the token, and therefore the correct prefix to the topic name can be generated.
 
-## How to get a streaming token
+## How to get a streaming token (SDK Token)
 
 You can access these tokens by logging into Quix and clicking on `Settings` in the main left-hand navigation. Select your environment, and then click on `APIs and tokens` and then click on `Streaming Tokens`.
 
 If you are looking for a bearer token to access the Quix APIs, such as the Portal API, you can select `Personal Access Tokens`. These are custom JWTs.
 
-## How to use a streaming token
+## How to use a streaming token (SDK Token)
 
 The streaming token is primarily used to authenticate the [Quix Streams client library](https://quix.io/docs/quix-streams/introduction.html).
 
 When using Quix Streams in Quix Cloud, you no longer need to provide all broker credentials manually, they’ll be acquired when needed and set up automatically.
 
 !!! warning
 
-	Streaming  tokens do not have an expiration date. Treat them as you would a password. If you think they’re exposed, rotate them.
+	Streaming Tokens (SDK Tokens) do not have an expiration date. Treat them as you would a password. If you think they’re exposed, rotate them.
 
 ## Rotating your token
 
-If you suspect your streaming token may have been exposed, best practice is to rotate it. Within the `Streaming token` dialog, click `rotate them` to display the `Rotating streaming tokens` dialog. Two tokens are then displayed.
+If you suspect your streaming token (SDK Token) may have been exposed, best practice is to rotate it. Within the `Streaming token` dialog, click `rotate them` to display the `Rotating streaming tokens` dialog. Two tokens are then displayed.
 
 Having two keys lets you update your services without interruption, as both `Token 1` and `Token 2` are always valid. Rotating deactivates `Token 1`, `Token 2` takes its place and a new `Token 2` is generated.
 

diff --git a/docs/develop/integrate-data/overview.md b/docs/develop/integrate-data/overview.md
@@ -38,3 +38,17 @@ When using the Streaming Writer API you can use the HTTP interface if a continou
 ## Integrations
 
 There is also a [section](../../integrations/overview.md) in this documentation providing more information on specific integrations you can use for connecting Quix with products such as InfluxDB.
+
+## Installing Quix Streams
+
+To install Quix Streams with `pip`:
+
+```
+python3 -m pip install quixstreams
+```
+
+!!! tip
+
+    If you already have Quix Streams installed, make sure you are using the latest version with `python -m pip install quixstreams -U` or `python3 -m pip install quixstreams -U`, depending on how your system is set up.
+
+Note that if you're using Quix Cloud, then make sure the latest version of Quix Streams is available by adding it to the `requirements.txt` file, if it's not already been included as part of the code sample you are using.
diff --git a/docs/develop/integrate-data/quix-streams.md b/docs/develop/integrate-data/quix-streams.md
@@ -1,6 +1,22 @@
 # Using Quix Streams to ingest data
 
-You can use Quix Streams to push and pull data to and from Quix, as well as use it to transform data. 
+You can use Quix Streams to push and pull data to and from Quix, as well as use it to transform data.
+
+## Installing Quix Streams
+
+To install Quix Streams with `pip`:
+
+```
+python3 -m pip install quixstreams
+```
+
+!!! tip
+
+    If you already have Quix Streams installed, make sure you are using the latest version with `python -m pip install quixstreams -U` or `python3 -m pip install quixstreams -U`, depending on how your system is set up.
+
+Note that if you're using Quix Cloud, then make sure the latest version of Quix Streams is available by adding it to the `requirements.txt` file, if it's not already been included as part of the code sample you are using.
+
+## Example code
 
 Some example code showing Quix Streams pushing data into Quix is shown here:
 

diff --git a/docs/develop/integrate-data/read-csv.md b/docs/develop/integrate-data/read-csv.md
@@ -6,9 +6,23 @@ When you need to load data from a CSV file into a Quix service, one possibility
 
 Another option is to read the CSV file on some other system, such as your laptop, and publish that data into a Quix topic using the Quix Streams client library.
 
+## Installing Quix Streams
+
+To install Quix Streams with `pip`:
+
+```
+python3 -m pip install quixstreams
+```
+
+!!! tip
+
+    If you already have Quix Streams installed, make sure you are using the latest version with `python -m pip install quixstreams -U` or `python3 -m pip install quixstreams -U`, depending on how your system is set up.
+
+Note that if you're using Quix Cloud, then make sure the latest version of Quix Streams is available by adding it to the `requirements.txt` file, if it's not already been included as part of the code sample you are using.
+
 ## Streaming token
 
-You'll need a streaming token to authenticate with Quix if you're going to run a command-line program that publishes or subscribes to a Quix topic. 
+You'll need a streaming token (SDK token) to authenticate with Quix if you're going to run a command-line program that publishes or subscribes to a Quix topic. 
 
 !!! note
 

diff --git a/docs/get-started/install-cloud.md b/docs/get-started/install-cloud.md
@@ -0,0 +1,7 @@
+# Install Quix Streams in Quix Cloud
+
+If you're using [Quix Cloud](../quix-cloud/overview.md), then Quix Streams will be installed for you as long as it is in the `requirements.txt` file for the application you are building. This is typically the case if you are using a Quix predefined [code sample](../develop/code-samples.md).
+
+If you want to use Quix Streams in your application, ensure it is added to the `requirements.txt` file as illustrated here:
+
+![Install Quix Streams](../images/quix-streams-requirements.png)
diff --git a/docs/get-started/install.md b/docs/get-started/install.md
@@ -16,6 +16,10 @@ To install Quix Streams with `pip`:
 python3 -m pip install quixstreams
 ```
 
+!!! tip
+
+    If you already have Quix Streams installed, make sure you are using the latest version with `python -m pip install quixstreams -U` or `python3 -m pip install quixstreams -U`, depending on how your system is set up.
+
 ## Step 2: Create a simple app
 
 You'll now create a simple app to test your installation. You'll connect to a Quix public Kafka broker and consume and print messages.
@@ -29,7 +33,8 @@ import uuid
 # Connect to the public Quix hosted broker to consume data
 app = Application(
     broker_address="publickafka.quix.io:9092",  # Kafka broker address
-    consumer_group=str(uuid.uuid4())  # Kafka consumer group
+    consumer_group=str(uuid.uuid4()),  # Kafka consumer group
+    producer_extra_config={'enable.idempotence': False}
 )
 
 input_topic = app.topic("demo-onboarding-prod-chat", value_deserializer='json')

diff --git a/docs/get-started/welcome.md b/docs/get-started/welcome.md
@@ -5,24 +5,24 @@ description: Welcome to the Quix Developer documentation. This documentation inc
 
 # Welcome
 
-<p style="font-size: 1rem;">Quix is a complete platform for developing, deploying, and monitoring stream processing pipelines. You develop your <b>pipeline services in Python</b> using Quix Streams, and deploy them to containers managed in Kubernetes with a single click. You can develop and manage services on the command line, and also manage and visualize your pipelines in Quix Cloud.</p>
+<p style="font-size: 1rem;">Quix is a complete platform for developing, deploying, and monitoring stream processing pipelines. You can build producer/consumer/transform apps with Quix Streams and Python, build and test pipelines with the Quix CLI, and then deploy, manage and observe the pipelines in Quix Cloud.</p>
 
-<div class="grid cards" markdown>
-
-- __I'm comfortable on the command line__
+## Workflow summary
 
-    ---
+Your Quix workflow:
 
-    Start building your stream processing pipeline on the command line with Quix Streams and the Quix CLI.
+1. Develop your applications locally in Python with Quix Streams, the Quix CLI, and your IDE of choice.
+2. Test and debug your pipeline locally with the Quix CLI and Docker.
+3. Deploy to Quix Cloud for scalability and observability.
 
-    [Install Quix Streams :octicons-arrow-right-24:](./install.md)
+<div class="grid cards" markdown>
 
-- __I'd rather use the Cloud__
+- __Get started!__
 
     ---
 
-    You can sign up to [Quix Cloud for free](https://portal.platform.quix.io/self-sign-up){target=_blank}, and then build a stream processing pipeline with Quix Streams and Quix Cloud in under ten minutes.
+    Start building your stream processing pipeline locally on the command line with Quix Streams.
 
-    [Quix Cloud Quickstart :octicons-arrow-right-24:](../quix-cloud/quickstart.md)
+    [Install Quix Streams :octicons-arrow-right-24:](./install.md)
 
-</div>
+</div>
diff --git a/docs/images/quix-streams-requirements.png b/docs/images/quix-streams-requirements.png
diff --git a/docs/javascripts/runllm-widget.js b/docs/javascripts/runllm-widget.js
@@ -0,0 +1,17 @@
+document.addEventListener("DOMContentLoaded", function() {
+    var script = document.createElement('script');
+    script.defer = true;
+    script.type = 'module';
+    script.id = 'runllm-widget-script';
+    script.src = 'https://cdn.jsdelivr.net/npm/@runllm/search-widget@stable/dist/run-llm-search-widget.es.js';
+    script.setAttribute('version', 'stable');
+    script.setAttribute('runllm-preset', 'mkdocs');
+    script.setAttribute('runllm-server-address', 'https://api.runllm.com');
+    script.setAttribute('runllm-assistant-id', '111');
+    script.setAttribute('runllm-position', 'BOTTOM_RIGHT');
+    script.setAttribute('runllm-keyboard-shortcut', 'Mod+j');
+    script.setAttribute('runllm-slack-community-url', 'https://quix.io/slack-invite');
+    script.setAttribute('runllm-name', 'RunLLM');
+
+    document.head.appendChild(script);
+});
diff --git a/docs/kb/glossary.md b/docs/kb/glossary.md
@@ -14,12 +14,6 @@ Applications in Quix exist inside the Git branch associated with an [environment
 
 Read more about [applications](../create/overview.md).
 
-## Binary data
-
-Quix also supports any binary blob data.
-
-With this data you can stream, process and store any type of audio, image, video or lidar data, or anything that isn’t supported with time series, event, or metadata types.
-
 ## Code Samples
 
 Quix contains a large number of [open source](https://github.com/quixio/quix-samples){target=_blank} Code Samples. You can use these to quickly build out your stream processing pipeline. Generally the code samples are divided into three main categories: source, transform, destination. You can access the Code Samples from within the UI by using the navigation menu as show here:
@@ -48,11 +42,10 @@ Read more about [data ingestion](../develop/integrate-data/overview.md).
 
 ## Data types
 
-Quix supports time series data, events, metadata, and blobs with the following data types: 
+Quix supports time series data, events and metadata with the following data types: 
 
 * Numeric (double precision)
 * String (UTF-8)
-* Binary data (blobs)
 
 ## Deployment
 
@@ -194,7 +187,7 @@ A type of [connector](../connectors/index.md) where data is published to a Quix
 
 ## Stream
 
-A stream is a collection of data (time series data, events, binary blobs and metadata) that belong to a single session of a single source. For example:
+A stream is a collection of data (time series data, events and metadata) that belong to a single session of a single source. For example:
 
 * One journey for one car
 * One game session for one player

diff --git a/docs/quix-cloud/quickstart.md b/docs/quix-cloud/quickstart.md
@@ -85,7 +85,7 @@ You use the `psutil` module to retrieve the CPU load on your laptop.
 
 ## Get your SDK token
 
-To obtain your token, go to `Settings` in your default environment, and then click on the `APIs and tokens` tab. You can obtain the `Streaming Token` from there.
+To obtain your token, go to `Settings` in your default environment, and then click on the `APIs and tokens` tab. You can obtain the Streaming Token (SDK Token) from there.
 
 ## Set your token
 

diff --git a/docs/tutorials/clickstream/clickstream-producer.md b/docs/tutorials/clickstream/clickstream-producer.md
@@ -55,7 +55,6 @@ If you look at the messages in the `Messages` view, you'll see data has the foll
       "VD55179433"
     ]
   },
-  "BinaryValues": {},
   "TagValues": {}
 }
 ```

diff --git a/docs/tutorials/clickstream/data-enrichment.md b/docs/tutorials/clickstream/data-enrichment.md
@@ -58,7 +58,6 @@ The enriched data format:
       "F"
     ]
   },
-  "BinaryValues": {},
   "TagValues": {}
 }
 ```

diff --git a/docs/tutorials/computer-vision/add-service.md b/docs/tutorials/computer-vision/add-service.md
@@ -126,7 +126,6 @@ To create the transform:
                 "iVBOR/snip/QmCC"
                 ]
             },
-            "BinaryValues": {},
             "TagValues": {
                 "parent_streamId": [
                 "JamCams_00002.00820"

diff --git a/docs/tutorials/computer-vision/object-detection.md b/docs/tutorials/computer-vision/object-detection.md
@@ -60,11 +60,6 @@ Objects are detected in the frame by the YOLOv8 code. Data is published to the o
     ]
   },
   "StringValues": {},
-  "BinaryValues": {
-    "image": [
-      "(Binary of 152.47 KB)"
-    ]
-  },
   "TagValues": {}
 }
 ```

diff --git a/docs/tutorials/computer-vision/other-services.md b/docs/tutorials/computer-vision/other-services.md
@@ -125,7 +125,6 @@ The max vehicles service takes the total vehicle count and finds the maximum val
     ]
   },
   "StringValues": {},
-  "BinaryValues": {},
   "TagValues": {
     "window_start": [
       "2023-09-06 12:08:12.394372"

diff --git a/docs/tutorials/computer-vision/web-ui.md b/docs/tutorials/computer-vision/web-ui.md
@@ -101,7 +101,6 @@ The data read from the topic is as follows:
         "iVBO…to/v37HG18UyZ1Qz/fby/<snipped>+yXUGc5UVWZfIHnX0iqM6aEAAAAASUVORK5CYII="
     ]
   },
-  "BinaryValues": {},
   "TagValues": {
     "parent_streamId": [
       "JamCams_00001.02500"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ To obtain a PAT, log in to Quix, and click on your profile icon in the top right

		Alternatively, log in to Quix, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`.

		In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token for use with the Quix Streams client library.
		In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to generate PATs, or a Streaming Token (SDK Token) for use with the Quix Streams client library.
-Original file line number
+Diff line change
@@ Expand Up @@
           "VD55179433"
         ]
       },
-      "BinaryValues": {},
       "TagValues": {}
     }
     ```
@@ Expand Down @@