diff --git a/.github/workflows/build-commit-subfolder.yaml b/.github/workflows/build-commit-subfolder.yaml index d1d16509..487855fb 100644 --- a/.github/workflows/build-commit-subfolder.yaml +++ b/.github/workflows/build-commit-subfolder.yaml @@ -107,7 +107,7 @@ jobs: uses: actions/checkout@v3 with: repository: 'quixio/quix-streams' - ref: 'main' # when a dev branch exists we can get the dev content + ref: 'release/v0.5' # when a dev branch exists we can get the dev content #ref: '{{ steps.extract_branch.outputs.branch }}' path: 'client-library' diff --git a/.github/workflows/sync-build-deploy.yaml b/.github/workflows/sync-build-deploy.yaml index 7de1245b..bbc1c314 100644 --- a/.github/workflows/sync-build-deploy.yaml +++ b/.github/workflows/sync-build-deploy.yaml @@ -102,7 +102,7 @@ jobs: uses: actions/checkout@v3 with: repository: 'quixio/quix-streams' - ref: 'main' # when a dev branch exists we can get the dev content + ref: 'release/v0.5' # when a dev branch exists we can get the dev content #ref: '{{ steps.extract_branch.outputs.branch }}' path: 'client-library' diff --git a/BEST-PRACTICE.md b/BEST-PRACTICE.md index e56dcbd7..7eca213b 100644 --- a/BEST-PRACTICE.md +++ b/BEST-PRACTICE.md @@ -49,12 +49,14 @@ The Quix documentation search facility is incremental - you start typing your se Good navigation is **critical** to effective TBW. Once a reader finds themselves in the Quix documentation, they need to be able to quickly orientate themselves on the page and in the documentation set overall. -The main left-hand navbar, or TOC, provides the main element of the information architecture, and is purposely organized into the following top-level hierarchy: +The main left-hand navbar, or TOC, provides the main element of the information architecture, and is purposely organized into the following top-level hierarchy, based around the developer journey: -1. **Landing page and Quickstart**. The idea here is to quickly orientate the reader. From the landing page they can jump to key pieces of documentation. The Quickstart provides an easy way to "dip a toe" into Quix, and try the product out. The Quickstart is divided into two parts: one aimed at all users, and one specifically targeting developers. -2. **Quix Platform**. This is the main Quix product, and consists of the SaaS offering, UI, pipelines, deployments, and pre-built connectors and transforms. Concepts, How-Tos and Tutorials for Quix Platform are contained in here. -3. **Client Library**. The Quix Streams client library provides a very effective way to write scalable real-time streaming applications. Using Quix Streams you can create solutions that work with Quix Platform, or with other services depending on your requirement. The `Client Library` section also includes API reference documentation generated from source code for both the Python and C# versions of Quix Streams. -4. **APIs**. These are additional Quix APIs, other than those provided by Quix Streams. The documentation consists of general topics, as well as REST API references based on OAS3 documents. +1. Get started - you're new to Quix and went to get up and running quickly. +2. Create your project - you need to have a project to do anything in Quix. +3. Develop your application - this is the job or service that will actually do the work. +4. Deploy your application - you're now ready to deploy the application so it can be used. +5. Manage your projects/pipelines - a typical event streaming app consists of a collections of services (or jobs) connected in a pipeline. +6. Quix Streams - the client library, as a stand-alone product it is displayed as a top level item. The longer topics can be navigated using the right-hand "on this page" TOC. This enables you to quickly navigate through the sections of a topic. It is important that topics are structured with the correct heading levels. There should only ever be one `h1` heading per topic, but there can be several `h2`s. Section headings below `h3` should be used sparingly, as they won't be displayed in the navigation, and could indicate the topic has become too convoluted. The solution can be to split the topic into multiple topics, or otherwise rethink the structure. @@ -92,7 +94,7 @@ The key tooling used for the Quix documentation includes: Quix uses multiple (currently two) repositories to manage the Quix documentation, these are: -1. [Quix Docs](https://github.com/quixio/quix-docs) - this is the repository for general docs, Quix Platform docs, and API docs. +1. [Quix Docs](https://github.com/quixio/quix-docs) - this is the repository for general docs, Quix Cloud docs, and API docs. 2. [Quix Streams](https://github.com/quixio/quix-streams) - a stand-alone repository for Quix Streams, including all Quix Streams documentation. Quix uses the MkDocs [multirepo plugin](https://github.com/jdoiro3/mkdocs-multirepo-plugin) to import a complete repo and make it part of a documentation set. Quix uses this to import the Quix Streams documentation stored in the Quix Streams repo. diff --git a/WRITING-STYLE.md b/WRITING-STYLE.md index ca096f63..eda3da37 100644 --- a/WRITING-STYLE.md +++ b/WRITING-STYLE.md @@ -33,11 +33,28 @@ Use the following guidelines regarding the company's name: * Possessive: Quix's technology * Plural: "multiple Quix deployments." * Quix is the name of our company - * Quix Portal is our product, which includes: - * Managed Kafka - * Serverless compute - * Quix data store - * APIs +* Quix product: + * 'The whole thing" = Quix - one tool to build event streaming apps + * Components of Quix: + * Quix Cloud - Packaging of Quix SaaS that is fully managed and hosted on Quix owned and operated cloud infrastructure (the place where everything runs). + * Serverless - multi-tenant + * Dedicated - single-tenant + * Quix BYOC - Packaging of Quix SaaS designed for self-hosting on customer’s infrastructure + * Quix Event Streaming Application - (legacy: pipeline) a collection of applications and kafka topics that fulfill an event streaming component of an event-driven platform. + * Quix Kafka - Our specific installed version "flavour" of Kakfa vs Confluent Cloud (our "Confluent Integration"), Redpanda, Aiven. + * Quix Application: a service with a code project & a container + * Quix Connectors - Quix Applications that integrate data between external systems and Quix (sources, destinations) + * Quix Processors - Quix Applications that run code to transform data (transforms) + * Quix Containers - Quix Applications that act as auxiliary resources for an application + * Code Samples - Ready-to-run templates of code and service configuration to create your own Quix Services + * Quix Project - (legacy: workspace) one Git repository that contains all the code that you need to build and deploy an Event Streaming Application in multiple environments.. + + * CI/CD Features + * Quix Project Configuration - YAML files, they define workflow and setting and env variables as code. It describes your services, topics, and relations between them. + * Git Integration, Git (GitHub, Azure DevOps, GitLab) link to Quix Workspace. + * Quix Environments (staging, dev prod) - isolated infrastructure connected to a branch of your Git project + * Quix CLI (coming soon) + * Project Templates (legacy: blueprints) ungated experiences * Quix Streams is our client library: * A client library is a collection of code specific to one programming language. * Quix currently offers Python and C# client libraries. diff --git a/docs/apis/portal-api/setup.md b/docs/apis/portal-api/setup.md index 9ca4f403..a5e92889 100644 --- a/docs/apis/portal-api/setup.md +++ b/docs/apis/portal-api/setup.md @@ -18,7 +18,7 @@ Each of these is described in the following sections. Useful information can also be found in the settings panels for your environment: -1. Click `Settings` in the bottom left corner of the Quix portal. +1. Click `Settings` in the bottom left corner of the UI. 2. From `Project settings` select the environment you are working with. @@ -34,7 +34,7 @@ Personal Access Tokens, or PATs, are bearer tokens that can be used to authentic To obtain a PAT, log in to Quix, and click on your profile icon in the top right corner, then click `Personal Access Tokens`. You can then generate a PAT with a lifetime suitable for your use case. -Alternatively, log in to the Quix Portal, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`. +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. diff --git a/docs/apis/query-api/raw-data.md b/docs/apis/query-api/raw-data.md index 2fe72235..281884e3 100644 --- a/docs/apis/query-api/raw-data.md +++ b/docs/apis/query-api/raw-data.md @@ -60,7 +60,7 @@ In reality, you’ll have far more data in the stored data, so you’ll want to - `to` -Each stream you create has a unique ID. You can view the ID of a persisted via the Data section of the Quix Portal. Supply a list of stream IDs to restrict fetched data to just those streams: +Each stream you create has a unique ID. You can view the ID of a persisted via the Data section of the UI. Supply a list of stream IDs to restrict fetched data to just those streams: ```json { diff --git a/docs/apis/query-api/setup.md b/docs/apis/query-api/setup.md index f47cf86e..ed65c0c8 100644 --- a/docs/apis/query-api/setup.md +++ b/docs/apis/query-api/setup.md @@ -18,7 +18,7 @@ Each of these is described in the following sections. Useful information can also be found in the settings panels for your environment: -1. Click `Settings` in the bottom left corner of the Quix portal. +1. Click `Settings` in the bottom left corner of the UI. 2. From `Project settings` select the environment you are working with. @@ -34,7 +34,7 @@ Personal Access Tokens, or PATs, are bearer tokens that can be used to authentic To obtain a PAT, log in to Quix, and click on your profile icon in the top right corner, then click `Personal Access Tokens`. You can then generate a PAT with a lifetime suitable for your use case. -Alternatively, log in to the Quix Portal, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`. +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. diff --git a/docs/apis/streaming-reader-api/overview.md b/docs/apis/streaming-reader-api/overview.md index 39ad7c58..35665368 100644 --- a/docs/apis/streaming-reader-api/overview.md +++ b/docs/apis/streaming-reader-api/overview.md @@ -1,6 +1,6 @@ # Overview -As an alternative to Quix Streams, the Quix platform supports real-time data streaming over WebSockets (or Long Polling depending on client support). +Quix supports real-time data streaming over WebSockets (or Long Polling depending on client support). Clients can receive updates on data and definitions for parameters and events, as they happen. @@ -9,4 +9,3 @@ Streaming Reader API is typically used by clients written in languages not suppo !!! note The following examples use the Microsoft [SignalR](https://docs.microsoft.com/en-us/aspnet/core/signalr/javascript-client?view=aspnetcore-5.0){target=_blank} JavaScript client library. - diff --git a/docs/apis/streaming-reader-api/setup.md b/docs/apis/streaming-reader-api/setup.md index 711f1204..b1ed4664 100644 --- a/docs/apis/streaming-reader-api/setup.md +++ b/docs/apis/streaming-reader-api/setup.md @@ -18,7 +18,7 @@ Each of these is described in the following sections. Useful information can also be found in the settings panels for your environment: -1. Click `Settings` in the bottom left corner of the Quix portal. +1. Click `Settings` in the bottom left corner of the UI. 2. From `Project settings` select the environment you are working with. @@ -34,7 +34,7 @@ Personal Access Tokens, or PATs, are bearer tokens that can be used to authentic To obtain a PAT, log in to Quix, and click on your profile icon in the top right corner, then click `Personal Access Tokens`. You can then generate a PAT with a lifetime suitable for your use case. -Alternatively, log in to the Quix Portal, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`. +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. diff --git a/docs/apis/streaming-writer-api/setup.md b/docs/apis/streaming-writer-api/setup.md index 79eb526c..d2564135 100644 --- a/docs/apis/streaming-writer-api/setup.md +++ b/docs/apis/streaming-writer-api/setup.md @@ -18,7 +18,7 @@ Each of these is described in the following sections. Useful information can also be found in the settings panels for your environment: -1. Click `Settings` in the bottom left corner of the Quix portal. +1. Click `Settings` in the bottom left corner of the UI. 2. From `Project settings` select the environment you are working with. @@ -34,7 +34,7 @@ Personal Access Tokens, or PATs, are bearer tokens that can be used to authentic To obtain a PAT, log in to Quix, and click on your profile icon in the top right corner, then click `Personal Access Tokens`. You can then generate a PAT with a lifetime suitable for your use case. -Alternatively, log in to the Quix Portal, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`. +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. diff --git a/docs/connectors/index.md b/docs/connectors/index.md index 382bf769..e5f6c5c2 100644 --- a/docs/connectors/index.md +++ b/docs/connectors/index.md @@ -4,6 +4,6 @@ Connectors are part of our [open source](https://github.com/quixio/quix-samples) Connectors help our users connect with other vendors such as AWS and Kafka. -You can explore the connector README files here in Quix Docs. When you are ready to start using them, head over to the Quix Code Samples [GitHub](https://github.com/quixio/quix-samples){target="_blank"} repository, or [sign up](https://quix.io/signup){target="_blank"} and [login to the platform](https://portal.platform.quix.ai/){target="_blank"}. +You can explore the connector README files here in Quix Docs. When you are ready to start using them, head over to the Quix Code Samples [GitHub](https://github.com/quixio/quix-samples){target="_blank"} repository, or [sign up](https://quix.io/signup){target="_blank"} and [log in to the platform](https://portal.platform.quix.ai/){target="_blank"}. [//]: <> (#connectors_tile_replacement) \ No newline at end of file diff --git a/docs/create/syncing-environment.md b/docs/create/syncing-environment.md index f494391b..433b2aad 100644 --- a/docs/create/syncing-environment.md +++ b/docs/create/syncing-environment.md @@ -8,7 +8,7 @@ You can always review the changes that will be made to your `quix.yaml` file, be The rules around manual and automatic synchronization are: -1. Operations performed in the Quix portal should not cause "out of sync", as those operations are automatically saved to the Git repository. This is the case for both Quix-managed and third-party hosted Git. +1. Operations performed in Quix should not cause "out of sync", as those operations are automatically saved to the Git repository. This is the case for both Quix-managed and third-party hosted Git. 2. The exception to this is the case of YAML variables. When variables are created, if those are included in the `quix.yaml`, you will need to perform manual synchronization. You are prompted if this is required. 3. If you change the `quix.yaml` in the Git repository, then you may get "out of sync". The `quix.yaml` file currently only includes topics and deployments. diff --git a/docs/deploy/deploy-public-page.md b/docs/deploy/deploy-public-page.md index 492f2d44..59a65813 100644 --- a/docs/deploy/deploy-public-page.md +++ b/docs/deploy/deploy-public-page.md @@ -1,6 +1,6 @@ # How to deploy a public service -The Quix Platform enables you to deploy public-facing web pages and APIs. +Quix enables you to deploy public-facing web pages and APIs. This how-to will help to explain the features and options and ensure projects containing public facing web pages and APIs are successful. diff --git a/docs/deploy/environment-variables.md b/docs/deploy/environment-variables.md index 373886ee..f54798ff 100644 --- a/docs/deploy/environment-variables.md +++ b/docs/deploy/environment-variables.md @@ -1,6 +1,6 @@ -# How to add environment variables in Quix Platform +# How to add environment variables in Quix -In Quix Platform, it is possible to create new environment variables that your code can then access. This is useful for things like API keys, secrets, and passwords for other services that your code may need to access. +In Quix, it is possible to create new environment variables that your code can then access. This is useful for things like API keys, secrets, and passwords for other services that your code may need to access. ## To create an environment variable diff --git a/docs/develop/apis-overview.md b/docs/develop/apis-overview.md index 2d70d6a4..3e792748 100644 --- a/docs/develop/apis-overview.md +++ b/docs/develop/apis-overview.md @@ -1,6 +1,6 @@ # Quix APIs Overview -The Quix Platform provides several APIs. These are: +Quix provides several APIs. These are: * Streaming Writer API * Streaming Reader API @@ -15,7 +15,7 @@ While [Quix Streams](../client-library-intro.md) is the main client library for In these situations Streaming Reader and Writer APIs can provide an alternative solution - for example, they can easily be accommodated in a modern web browser, or using most modern programming languages with an HTTP or SignalR client. -Portal API is useful for automating processes normally carried out manually in the Quix Portal. +Portal API is useful for automating processes normally carried out manually in Quix. Query API is useful for testing and examining data persisted into the Quix internal database. @@ -50,13 +50,13 @@ Streaming Reader uses Microsoft's [SignalR](https://learn.microsoft.com/en-us/as ## Portal API -The [Portal API](../apis/portal-api/overview.md) gives access to the Quix Portal interface enabling you to automate your project deployment, management and monitoring. For example, you could build command line tools in any language with an HTTP interface available, to create, deploy, and monitor services. +The [Portal API](../apis/portal-api/overview.md) gives access to Quix, enabling you to automate your project deployment, management and monitoring. For example, you could build command line tools in any language with an HTTP interface available, to create, deploy, and monitor services. [Read more about Portal API](../apis/portal-api/overview.md) ## Query API -The [Query API](../apis/query-api/overview.md) enables you to fetch persisted data from Quix. You can use it for exploring the platform, testing, prototyping applications, or working with persisted data in any language with HTTP capabilities. +The [Query API](../apis/query-api/overview.md) enables you to fetch persisted data from Quix. You can use it for exploring Quix, testing, prototyping applications, or working with persisted data in any language with HTTP capabilities. !!! note diff --git a/docs/develop/authentication/personal-access-token.md b/docs/develop/authentication/personal-access-token.md index 1bbdac2b..3ddcf0a9 100644 --- a/docs/develop/authentication/personal-access-token.md +++ b/docs/develop/authentication/personal-access-token.md @@ -4,6 +4,6 @@ Personal Access Tokens, or PATs, are bearer tokens that can be used to authentic To obtain a PAT, log in to Quix, and click on your profile icon in the top right corner, then click `Personal Access Tokens`. You can then generate a PAT with a lifetime suitable for your use case. -Alternatively, log in to the Quix Portal, and click `Settings` in the main left-hand navigation. Then, for a specific environment, click `APIs and tokens`. +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. diff --git a/docs/develop/authentication/streaming-token.md b/docs/develop/authentication/streaming-token.md index fe6f3e49..45a0a1de 100644 --- a/docs/develop/authentication/streaming-token.md +++ b/docs/develop/authentication/streaming-token.md @@ -1,12 +1,12 @@ # Streaming token -A streaming token is a type of bearer token that can be used to authenticate your client library (Quix Streams) to access functionality necessary for streaming actions. Think of streaming tokens as a token you use to access the Quix Portal but with limited scope. +A streaming token is a type of bearer token that can be used to authenticate your client library (Quix Streams) to access functionality necessary for streaming actions. Think of streaming tokens as a token you use to access Quix, but with limited scope. Each environment comes with one of these tokens, limited in use for that specific environment. ## How to find -You can access these tokens by logging into the Quix Portal 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`. +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. @@ -28,7 +28,7 @@ Having two keys lets you update your services without interruption, as both `Tok You have two main options regarding how you rotate: -1. The easiest way to rotate comes with some service downtime. This assumes you do not directly set the token for your `QuixStreamingClient`, instead you let the platform take care of it for you by using the default environment variable. In this scenario all you have to do is rotate keys, stop and start all your deployments. Until a service is restarted it’ll try to communicate with the platform using the deactivated token. If you’re using local environments, those need to be updated manually. +1. The easiest way to rotate comes with some service downtime. This assumes you do not directly set the token for your `QuixStreamingClient`, instead you let Quix take care of it for you by using the default environment variable. In this scenario all you have to do is rotate keys, stop and start all your deployments. Until a service is restarted it’ll try to communicate with Quix using the deactivated token. If you’re using local environments, those need to be updated manually. 2. The alternative option is more complicated, but you can achieve no downtime. This requires you to set a new environment variable you control. This should point to the token to be used. Provide the value of this environment variable to `QuixStreamingClient` by passing it as an argument. Once you have that, set the value of this environment variable to `Token 2` and start your services. When you’re sure you replaced the tokens for all services, rotate your keys. diff --git a/docs/develop/code-samples.md b/docs/develop/code-samples.md index 758b2ec4..347c19c3 100644 --- a/docs/develop/code-samples.md +++ b/docs/develop/code-samples.md @@ -22,4 +22,4 @@ You can become a contributor of our Code Samples by generating new samples or up !!! important - Note that when you use a public code sample in the Quix Portal, it is added to your private repository, so any changes you make can be kept private if you so wish. Of course, if you are working in a public repository, then any code samples you add or modify will also be public. + Note that when you use a public code sample in Quix, it is added to your private repository, so any changes you make can be kept private if you so wish. Of course, if you are working in a public repository, then any code samples you add or modify will also be public. diff --git a/docs/develop/integrate-data/external-destination.md b/docs/develop/integrate-data/external-destination.md index 019f6e0b..6925c717 100644 --- a/docs/develop/integrate-data/external-destination.md +++ b/docs/develop/integrate-data/external-destination.md @@ -4,7 +4,7 @@ One simple way to read data out of a Quix topic, is to use the prebuilt connecto To use the `External destination` connector, step through the following procedure: -1. In the Quix Portal click on `Code Samples` in the left-hand sidebar. +1. In the UI click on `Code Samples` in the left-hand sidebar. 2. Search for `External destination`. diff --git a/docs/develop/integrate-data/external-source.md b/docs/develop/integrate-data/external-source.md index a772ddf9..9345edb4 100644 --- a/docs/develop/integrate-data/external-source.md +++ b/docs/develop/integrate-data/external-source.md @@ -4,7 +4,7 @@ One simple way to write data into a Quix topic, is to use the prebuilt connector To use the `External source` connector, step through the following procedure: -1. In the Quix Portal click on `Code Samples` in the left-hand sidebar. +1. In the UI click on `Code Samples` in the left-hand sidebar. 2. Search for `External source`. diff --git a/docs/develop/integrate-data/jupyter-nb.md b/docs/develop/integrate-data/jupyter-nb.md index c8ba4792..78b3dff4 100644 --- a/docs/develop/integrate-data/jupyter-nb.md +++ b/docs/develop/integrate-data/jupyter-nb.md @@ -1,6 +1,6 @@ # Use Jupyter Notebook -In this documentation, you learn how to use Jupyter Notebook to analyze data persisted in the Quix platform. +In this documentation, you learn how to use Jupyter Notebook to analyze data persisted in Quix. ## Why this is important @@ -8,7 +8,7 @@ Although Quix is a real-time platform, to build real-time in-memory models and d ## Prerequisites -You'll need some data stored in the Quix platform. You can use any of the Quix [data sources](../../connectors/index.md) available in the Quix Code Samples. +You'll need some data stored in Quix. You can use any of the Quix [data sources](../../connectors/index.md) available in the Quix Code Samples. You can also follow the onboarding process when you [sign-up to Quix](https://portal.platform.quix.ai/self-sign-up?xlink=docs){target=_blank}. This process helps you create a source. @@ -32,7 +32,7 @@ Then create a new Python 3 notebook: The Quix web application has a Python code generator to help you connect your Jupyter notebook with Quix. -You need to be logged into the platform for this. To import persisted data: +You need to be logged into Quix for this. To import persisted data: 1. Select an environment. diff --git a/docs/develop/integrate-data/quix-streams.md b/docs/develop/integrate-data/quix-streams.md index 590d2d71..63fd19bd 100644 --- a/docs/develop/integrate-data/quix-streams.md +++ b/docs/develop/integrate-data/quix-streams.md @@ -2,7 +2,7 @@ You can use Quix Streams to push and pull data to and from Quix, as well as use it to transform data. -Some example code showing Quix Streams pushing data inot the platform is shown here: +Some example code showing Quix Streams pushing data into Quix is shown here: ```python import psutil diff --git a/docs/develop/integrate-data/read-csv.md b/docs/develop/integrate-data/read-csv.md index 63d317f9..aa41c667 100644 --- a/docs/develop/integrate-data/read-csv.md +++ b/docs/develop/integrate-data/read-csv.md @@ -30,7 +30,7 @@ Note, the data is loaded into a pandas dataframe, and then published to the outp If you're not using pandas, you can write your own code to load data from a CSV file. -The following code demonstrates loading data from a CSV file and adding the timestamp column, and only adding other data columns of interest. In addition, this code is designed to be run on the command line. This code reads a CSV file on, for example, your laptop, and pushes the data into Quix Platform, using the Quix Streams client library: +The following code demonstrates loading data from a CSV file and adding the timestamp column, and only adding other data columns of interest. In addition, this code is designed to be run on the command line. This code reads a CSV file on, for example, your laptop, and pushes the data into Quix, using the Quix Streams client library: ``` python # pip install quixstreams diff --git a/docs/develop/integrate-data/streaming-apis.md b/docs/develop/integrate-data/streaming-apis.md index 0c4ea6c5..49f58d91 100644 --- a/docs/develop/integrate-data/streaming-apis.md +++ b/docs/develop/integrate-data/streaming-apis.md @@ -44,7 +44,7 @@ Some example code that shows how to connect to Quix and write data into a Quix s