Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To access the preview site follow the link generated for you on the PR, as shown

If you plan to make more than basic changes to the documentation, you should become familiar with our contribution guides. There are three main guides in addition to this README:

1. [Contribution guide](./CONTRIBUTING.md) - more detailed notes on how to contribute through a GitHub issue or PR.
1. [Contribution Guide](./CONTRIBUTING.md) - more detailed notes on how to contribute through a GitHub issue or PR.
2. [Writing Style Guide](./WRITING-STYLE.md) - this covers our documentation writing style in detail. Generally you should write in the second person, present tense, active voice, using International English. Try to use simple, directive language. Further details are contained in the guide.
3. [Best Practice Guide](./BEST-PRACTICE.md) - this covers our general aproach to technical writing, which is to use topic-based writing, with effective incremental search, and structured navigation. You don't need to be familiar with this to contribute, but it's a useful resource if you're interested in making more in-depth contributions.

Expand Down
1 change: 1 addition & 0 deletions WRITING-STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,7 @@ Some further examples of writing style guides are:
* [Google's guide on inclusive documentation](https://developers.google.com/style/inclusive-documentation)
* [Vonage/Nexmo](https://developer.nexmo.com/contribute/guides/writing-style-guide)
* [Ably](https://github.com/ably/docs/blob/main/writing-style-guide.md)
* [Redpanda](https://github.com/redpanda-data/documentation/blob/dev/meta_docs/style_guide.mdx)

## See also

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/tutorials/eventDetection/crash-detection.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ In reality our ML model was trained to detect the difference between a phone bei

Follow these steps to start creating the `crash detection service`:

1. Navigate to `Code Samples` and search for `Empty template`.
1. Navigate to `Code Samples` and search for `Starter transformation`.

2. Click `Preview code` on the transformation template (shown with a violet highlight).
2. Ensure you have located the Python starter transformation and click `Preview code`.

3. Click `Edit code`.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/tutorials/eventDetection/data-acquisition.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ Follow these instructions to deploy the data source:

1. Navigate to `Code Samples`, select `Python` under languages and `Source` under pipeline stage.

2. In the search box enter `Empty template`.
2. In the search box enter `Starter source`.

3. On `Empty template`, click `Preview code` then `Edit code`.
3. On `Starter source`, click `Preview code` then `Edit code`.

4. Change the `Name` field to `CSV data source`.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/tutorials/image-processing/decode.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ In this part of the tutorial you decode the base64 encoded images coming from th

Follow these steps to deploy the **base64 decoder service**:

1. Navigate to the `Code Samples` and locate the Python `Empty template` transformation.
1. Navigate to the `Code Samples` and locate the Python `Starter transformation`.

!!! tip
You can use the filters on the left hand side to select `Python` and `Transformation` then select `Empty template` in the resulting filtered items.
You can use the filters on the left hand side to select `Python` and `Transformation` then select `Starter transformation` in the resulting filtered items.

2. Click `Edit code`.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/tutorials/quick-start/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ In this section you will learn how to use a template to help quickly build a Qui

1. Navigate to the `Code Samples`.

2. Search for the `Starter source`. It should have a blue highlight (blue is used to indicate a source). Make sure the Python language version is selected.
2. Search for the `Starter source` item. Ensure you select the Python version.

3. Click `Preview code`.

Expand Down Expand Up @@ -314,7 +314,7 @@ You will now locate a suitable transformation template and modify it to handle t

1. Search the Code Samples for `Starter transformation`. Make sure you select the Python language version.

2. Click `Preview code`.
2. Click `Preview code` on the Python version.

3. Click `Edit code`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Follow these steps to locate and save the code to your workspace:

3. Type = `Basic templates`

2. Select `Empty template - Transformation`.
2. Select `Starter transformation`.

- This is a simple example of how to subscribe and publish messages to Quix.
- This is a simple example of how to subscribe to and publish messages to Quix.
- You can't edit anything here, this is a read-only view so you can explore the files in the template and see what each one does.

3. Click `Preview code` then `Edit code`.
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/tutorials/sentiment-analysis/twitter-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Follow these steps to code and deploy the tweet-to-chat conversion stage:

3. Type = `Basic templates`

2. Select `Empty template - Transformation`.
2. Select `Starter transformation`.

3. Click `Preview code` then `Edit code`.

Expand Down
Binary file removed docs/platform/tutorials/telemetry-data/image1.png
Binary file not shown.
Binary file removed docs/platform/tutorials/telemetry-data/image2.png
Binary file not shown.
Binary file removed docs/platform/tutorials/telemetry-data/image3.png
Binary file not shown.
Binary file removed docs/platform/tutorials/telemetry-data/image4.png
Binary file not shown.
236 changes: 0 additions & 236 deletions docs/platform/tutorials/telemetry-data/telemetry-data.md

This file was deleted.

1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ nav:
- 'No code sentiment analysis': 'platform/tutorials/nocode-sentiment/nocode-sentiment-analysis.md'
- 'RSS Processing': 'platform/tutorials/rss-tutorial/rss-processing-pipeline.md'
- 'Currency Alerting': 'platform/tutorials/currency-alerting/currency-alerting.md'
- 'Telemetry data': 'platform/tutorials/telemetry-data/telemetry-data.md'
- 'Train and deploy an ML model':
- 'How to train an ML model': 'platform/tutorials/train-and-deploy-ml/train-ml-model.md'
- 'Run ML model in realtime environment': 'platform/tutorials/train-and-deploy-ml/deploy-ml.md'
Expand Down
12 changes: 12 additions & 0 deletions overrides/main.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
{% extends "base.html" %}

{% block extrahead %}
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','{{ config.extra.analytics.property }}');</script>
<!-- End Google Tag Manager -->
{{ super }}
{% endblock %}

{% block analytics %}
{{ super }}
<!-- Google Tag Manager (noscript) -->
Expand Down