Docs Release 2023-04-002

.github/workflows/build-commit-subfolder.yaml

@@ -135,20 +135,20 @@ jobs:
       run: "sed -i 's,./images,./assets/client-library/,g' docs/client-library-intro.md"
 
     # clone the library repo
-    - name: Checkout Library
+    - name: Checkout Samples
       uses: actions/checkout@v3
       with:
-        repository: 'quixio/quix-library'
+        repository: 'quixio/quix-samples'
         ref: 'develop' # when a dev branch exists we can get the dev content
         #ref: '{{ steps.extract_branch.outputs.branch }}'
-        path: 'library'
+        path: 'samples'
 
     # use our own GitHub Action to bring in library readme files
-    - name: Quix Library readme.md importer
-      uses: quixio/LibraryToMKDocsReadmeMergeAction@v2.12
+    - name: Quix Samples readme.md importer
+      uses: quixio/LibraryToMKDocsReadmeMergeAction@v2.13
       id: readme_importer
       with:
-        LIBRARY_REPO_PATH: "library"
+        LIBRARY_REPO_PATH: "samples"
         DOCS_PATH: ""
         REPLACEMENT_PLACEHOLDER: "#ConnectorsGetInsertedHere"
         README_DEST: "docs/library_readmes/connectors"

.github/workflows/sync-build-deploy.yaml

@@ -138,20 +138,20 @@ jobs:
       ### IMPORT LIBRARY README.MD FILES INTO DOCS
       ####################################################
       # clone the library repo
-      - name: Checkout Library
+      - name: Checkout Samples
         uses: actions/checkout@v3
         with:
-          repository: 'quixio/quix-library'
+          repository: 'quixio/quix-samples'
           ref: 'develop' # when a dev branch exists we can get the dev content
           #ref: '{{ steps.extract_branch.outputs.branch }}'
-          path: 'library'
+          path: 'samples'
 
       # use our own GitHub Action to bring in library readme files
-      - name: Quix Library readme.md importer
-        uses: quixio/LibraryToMKDocsReadmeMergeAction@v2.12
+      - name: Quix Samples readme.md importer
+        uses: quixio/LibraryToMKDocsReadmeMergeAction@v2.13
         id: readme_importer
         with:
-          LIBRARY_REPO_PATH: "library"
+          LIBRARY_REPO_PATH: "samples"
           DOCS_PATH: ""
           REPLACEMENT_PLACEHOLDER: "#ConnectorsGetInsertedHere"
           README_DEST: "docs/library_readmes/connectors"

docs/apis/data-catalogue-api/aggregate-tags.md

@@ -6,7 +6,7 @@ you’ll want to group results by that tag. You can do so via the
 
 ## Before you begin
 
-  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Library](../../platform/samples/samples.md) to set some up.
+  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Samples](../../platform/samples/samples.md) to set some up.
 
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.

docs/apis/data-catalogue-api/aggregate-time.md

@@ -5,7 +5,7 @@ You can downsample and upsample data from the catalogue using the
 
 ## Before you begin
 
-  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Library](../../platform/samples/samples.md) to set some up.
+  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Samples](../../platform/samples/samples.md) to set some up.
 
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.

docs/apis/data-catalogue-api/filter-tags.md

@@ -5,7 +5,7 @@ so they can be used to efficiently filter data.
 
 ## Before you begin
 
-  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Library](../../platform/samples/samples.md) to set some up.
+  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Samples](../../platform/samples/samples.md) to set some up.
 
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.

docs/apis/data-catalogue-api/intro.md

@@ -18,7 +18,7 @@ how to [form a typical request to the
 API](request.md).
 
 You’ll also need to have some data stored in the Quix platform for API
-use to be meaningful. You can use any Source of our [Quix Library](../../platform/samples/samples.md) to do this using the Quix
+use to be meaningful. You can use any Source of our [Quix Samples](../../platform/samples/samples.md) to do this using the Quix
 portal.
 
 ## Further documentation

docs/apis/data-catalogue-api/raw-data.md

@@ -6,7 +6,7 @@ results.
 
 ## Before you begin
 
-  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Library](../../platform/samples/samples.md) to set some up.
+  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Samples](../../platform/samples/samples.md) to set some up.
 
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.

docs/apis/data-catalogue-api/streams-filtered.md

@@ -5,7 +5,7 @@ request to the `/streams` endpoint.
 
 ## Before you begin
 
-  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Library](../../platform/samples/samples.md) to set some up.
+  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Samples](../../platform/samples/samples.md) to set some up.
 
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.

docs/apis/data-catalogue-api/streams-models.md

@@ -6,7 +6,7 @@ endpoint.
 
 ## Before you begin
 
-  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Library](../../platform/samples/samples.md) to set some up.
+  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Samples](../../platform/samples/samples.md) to set some up.
 
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.

docs/apis/data-catalogue-api/streams-paged.md

@@ -8,7 +8,7 @@ use pagination parameters to group the results into smaller pages.
 
 ## Before you begin
 
-  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Library](../../platform/samples/samples.md) to set some up.
+  - If you don’t already have any Stream data in your workspace, you can use any Source of our [Quix Samples](../../platform/samples/samples.md) to set some up.
 
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.

docs/platform/connectors/index.md

@@ -1,9 +1,9 @@
 # Connectors
 
-Connectors are part of our [open source](https://github.com/quixio/quix-library){target="_blank"} repository of samples, examples and integrations.
+Connectors are part of our [open source](https://github.com/quixio/quix-samples){target="_blank"} repository of samples, examples and integrations.
 
 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 Library [GitHub](https://github.com/quixio/quix-library){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 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"}.
 
 [//]: <> (#connectors_tile_replacement)

docs/platform/how-to/deploy-public-page.md

@@ -4,13 +4,13 @@ The Quix SaaS platform allows 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.
 
-## Library samples
+## Samples
 
-In our Library you can find our `Web API Template` which demonstrates how to create a API using `Node`.
+In our samples you can find our `Web API Template` which demonstrates how to create a API using `Node`.
 
 There are also examples dashboard and web/UI examples using `Dash`, `Streamlit` and `Angular`.
 
-![Library examples](../images/library.png){width=500px}
+![Samples](../images/library.png){width=500px}
 
 ## The code
 
@@ -42,7 +42,7 @@ To access your public facing service or web site you must enable `Public Access`
 
 ## Security
 
-Please note that the basic examples, included in our library, do not include any security features and come with no warranty.
+Please note that the basic examples, included in our Quix Samples, do not include any security features and come with no warranty.
 
 Quix advises you to build in a security layer to ensure your data is secure and only the intended recipients have access to it.
 

docs/platform/how-to/jupyter-nb.md

@@ -13,7 +13,7 @@ analysis so much easier.
 ## Preparation
 
 You’ll need some data stored in the Quix platform. You can use any of
-our Data Sources available in the samples Library, or just follow the
+our Data Sources available in the Quix Samples, or just follow the
 onboarding process when you [sign-up to
 Quix](https://portal.platform.quix.ai/self-sign-up?xlink=docs){target=_blank}.
 

docs/platform/intro.md

@@ -45,7 +45,7 @@ To achieve these goals Quix Portal includes the following features:
   - **Online IDE**: Develop and Run your streaming applications directly
     on the browser without setting up a local environment.
 
-  - **Library**: Choose between hundreds of autogenerated code examples
+  - **Samples**: Choose between hundreds of autogenerated code examples
     ready to run and deploy from our Online IDE.
 
   - **One click deployments**: Deploy and manage your streaming
@@ -122,7 +122,7 @@ will build selected GIT commit into a docker image.
 
 ### Docker integration
 
-Each code example generated using the **Quix library** is shipped with a
+Each code example generated using the **Quix Samples** is shipped with a
 `Dockerfile` that is designed to work in the **Quix serverless compute
 environment** powered by **Kubernetes**. You can alter this file if
 necessary. When you deploy a service with Quix, a code reference to GIT

docs/platform/samples/samples.md

@@ -1,10 +1,9 @@
 # Code Samples
 
-The Quix Portal includes a Library of templates and sample projects that
-you can use to start working with the platform.
+The Quix Portal includes Quix Samples, a collection of templates and sample projects that you can use to start working with the platform.
 
 Quix allows explore the samples and save them as a new Project and immediately Run or Deploy them. If you don’t have a Quix account yet, go [sign-up to Quix](https://portal.platform.quix.ai/self-sign-up?xlink=docs){target=_blank} and create one.
 
-The backend of the Quix Library is handled by a public [Open source repository](https://github.com/quixio/quix-library){target=_blank} on GitHub, so you can become a contributor of our Library generating new samples or updating existing ones.
+The backend of the Quix Samples is handled by a public [Open source repository](https://github.com/quixio/quix-samples){target=_blank} on GitHub. You can become a contributor of our Samples by generating new samples or updating existing ones.
 
 ![Library.png](library.png)

docs/platform/tutorials/currency-alerting/currency-alerting.md

@@ -6,9 +6,9 @@ In this tutorial you will learn how to build a real-time streaming pipeline that
 
 In this tutorial you will learn:
 
-* How to use an existing library item to interface Quix to a real-time event stream. In this tutorial this is a stream of trading data from CoinAPI.
+* How to use an existing sample to interface Quix to a real-time event stream. In this tutorial this is a stream of trading data from CoinAPI.
 * How to create a transformation. 
-* How to use an existing library item to interface Quix to a mobile device.
+* How to use an existing sample to interface Quix to a mobile device.
 
 ## Getting help
 
@@ -36,9 +36,9 @@ The colors describe the role of the microservice that is being deployed. The pos
 
 ## Setting up the CoinAPI source
 
-In this section you will learn how to set up the source library item and deploy it in your pipeline as a microservice.
+In this section you will learn how to set up the source sample and deploy it in your pipeline as a microservice.
 
-This library item, when deployed as a microservice in the Quix pipeline, connects a live stream of updates for the currency pair: `BTC/USD`. This real-time exchange rate data is streamed in from the [CoinAPI](https://www.coinapi.io/){target=_blank} through its [Websocket](https://en.wikipedia.org/wiki/WebSocket){target=_blank} interface. The free [sandbox version](https://docs.coinapi.io/#endpoints-2){target=_blank} is used for the purposes of this tutorial. 
+This sample, when deployed as a microservice in the Quix pipeline, connects a live stream of updates for the currency pair: `BTC/USD`. This real-time exchange rate data is streamed in from the [CoinAPI](https://www.coinapi.io/){target=_blank} through its [Websocket](https://en.wikipedia.org/wiki/WebSocket){target=_blank} interface. The free [sandbox version](https://docs.coinapi.io/#endpoints-2){target=_blank} is used for the purposes of this tutorial. 
 
 To summarize this functionality:
 
@@ -47,13 +47,13 @@ To summarize this functionality:
 
 To set up the CoinAPI source, follow these steps:
 
-1. In the [Quix Portal](https://portal.platform.quix.ai/){target=_blank}, click the `Library` icon in the main left-hand navigation.
+1. In the [Quix Portal](https://portal.platform.quix.ai/){target=_blank}, click the `Samples` icon in the main left-hand navigation.
 
-2. In the search box on the library page, enter "CoinAPI - Exchange Rate Feed".
+2. In the search box on the samples page, enter "CoinAPI - Exchange Rate Feed".
 
-   You will see the Coin API library item appear in the search results: ![CoinAPI library item](coinapi.png "CoinAPI library item")
+   You will see the Coin API sample appear in the search results: ![CoinAPI sample](coinapi.png "CoinAPI sample")
 
-3. Click the `Preview code` button, and on the page that appears, click the `Edit code` button. When you choose to edit a library item, Quix prompts you to create a copy of it as a project, as library items are read-only.
+3. Click the `Preview code` button, and on the page that appears, click the `Edit code` button. When you choose to edit a sample, Quix prompts you to create a copy of it as a project, as sample are read-only.
 
       Optionally, you could have clicked the `Setup & deploy` button, which would have deployed the microservice directly. However, in this tutorial, you are given the opportunity to first look at the code, and modify it if necessary.
 
@@ -67,11 +67,11 @@ To set up the CoinAPI source, follow these steps:
     | `asset_id_base` | The short code for the _base_ currency that you want to track, for example BTC. |
     | `asset_id_quote`  | The short code for the _target_ currency in which prices will be quoted, for example, USD. |
 
-5. Click `Save as project`. You now have a copy of the CoinAPI library item in your workspace.
+5. Click `Save as project`. You now have a copy of the CoinAPI sample in your workspace.
 
-6. Click the `Deploy` button. The library item is deployed as a service and automatically started.
+6. Click the `Deploy` button. The sample is deployed as a service and automatically started.
 
-      Once the library item has been deployed, you’ll be redirected to the workspace home page, where you can see the service in the pipeline context, as was illustrated previously.
+      Once the sample has been deployed, you’ll be redirected to the workspace home page, where you can see the service in the pipeline context, as was illustrated previously.
 
 7. Click the CoinAPI service card to inspect the logs:
 
@@ -96,12 +96,12 @@ To summarize this functionality:
 * When the threshold criteria are met, the microservice writes an alert message to a topic called `currency-rate-alerts`. 
 * Downstream services can then read fom this topic and send alerts and notifications whenever they detect a new message.
 
-To set up the Threshold Alert item, follow these steps:
+To set up the Threshold Alert sample, follow these steps:
 
-1. Click on the Library icon in the left-hand navigation.
-2. In the search box on the library page, enter "Threshold Alerts".
+1. Click on the Samples icon in the left-hand navigation.
+2. In the search box on the samples page, enter "Threshold Alerts".
 
-      You will see the `Threshold Alert` library item appear in the search results: 
+      You will see the `Threshold Alert` sample appear in the search results: 
 
       ![Threshold Alert](threshold-alerts.png "Threshold Alert")
 
@@ -120,11 +120,11 @@ To set up the Threshold Alert item, follow these steps:
 
 5. Click `Save as project`. 
 
-      You now have a copy of the Threshold Alert library item in your workspace.
+      You now have a copy of the Threshold Alert sample in your workspace.
 
 6. Click the `Deploy` button. 
 
-      The library item is deployed as a service and automatically started. Once the microservice has been deployed, you'll be redirected to the pipeline view. 
+      The sample is deployed as a service and automatically started. Once the microservice has been deployed, you'll be redirected to the pipeline view. 
 
 7. Click the Threshold Alert service card to inspect the logs.
 
@@ -146,11 +146,11 @@ It also reads the contents of the message and enriches the notification with det
 
 To set up the push nonfiction microservice, follow these steps:
 
-1. Click on the Library icon in the left-hand navigation.
+1. Click on the Samples icon in the left-hand navigation.
 
-2. In the search box on the library page, enter "Pushover".
+2. In the search box on the samples page, enter "Pushover".
 
-      You will see the `Threshold Alert` library item appear in the search results: 
+      You will see the `Threshold Alert` sample appear in the search results: 
 
       ![Pushover Notifications](library-pushover.png "Pushover Notifications")
 
@@ -166,7 +166,7 @@ To set up the push nonfiction microservice, follow these steps:
     | `api_token` | Enter the API token that you generated for this application in your Pushover dashboard. For example: `azovmnbxxdxkj7j4g4wxxxdwf12xx4`. |
     | `user_key` | Enter the user key that you received when you signed up with Pushover. For example: `u721txxxgmvuy5dxaxxxpzx5xxxx9e`) |
 
-5. Click the `Save as project`. You now have a copy of the Pushover notification library item in your workspace.
+5. Click the `Save as project`. You now have a copy of the Pushover notification sample in your workspace.
 
 6. Click the `Deploy` button.
 

docs/platform/tutorials/data-science/data-science.md

@@ -72,14 +72,14 @@ This walk through covers the following steps:
 
 Start by getting the real time bikes stream. Use CityBikes to get real time bikes data (it doesn’t require a sign up or any keys).
 
-Instead of writing a lot of code you will use the Library to deploy a pre-built service that streams data from the New York CitiBikes api.
+Instead of writing a lot of code you will use the Samples to deploy a pre-built service that streams data from the New York CitiBikes api.
 
-1. Search the library for `New York` and select the `New York Bikes - Source` tile.
+1. Search the samples for `New York` and select the `New York Bikes - Source` tile.
 
-	![NY Bikes library tile](ny-bikes-library-tile.png){width=400px}
+	![NY Bikes sample tile](ny-bikes-library-tile.png){width=400px}
 
 	!!! tip 
-		The Library is on the left hand menu
+		Samples is on the left hand menu
 
 2. Click `Setup and deploy`
 
@@ -96,7 +96,7 @@ Instead of writing a lot of code you will use the Library to deploy a pre-built
 
 You now have a working real time stream of bike data. Now use the OpenWeather account to create a real time weather stream. The procedure is almost the same, so you should have no problems!
 
-1. Search the library for `weather` and select the `Open Weather API` tile.
+1. Search the samples for `weather` and select the `Open Weather API` tile.
 
 2. Click `Setup and deploy`
 
@@ -216,13 +216,13 @@ However, it would take several weeks to accumulate enough historic data to train
 
 ## 6. Run the model
 
-We have included our trained model artifacts as pickle files in the prediction code project and uploaded it to the open source library, so let's use them.
+We have included our trained model artifacts as pickle files in the prediction code project and uploaded it to the open source samples, so let's use them.
 
 ### Prediction service code
 
 Get the code for the prediction service.
 
-1. Click on the Library
+1. Click on Samples in the left hand navigation
 
 2. Search for `New York` and select the `New york Bikes - Prediction` tile