From 702f06522f06a64d1817065005299c49a55deba4 Mon Sep 17 00:00:00 2001 From: tbedford Date: Tue, 21 May 2024 16:19:13 +0100 Subject: [PATCH 1/3] [chore] - remove cloud first option --- RUNNING-DOCS-LOCALLY.md | 2 +- docs/get-started/welcome.md | 12 ++---------- overrides/main.html | 2 +- 3 files changed, 4 insertions(+), 12 deletions(-) diff --git a/RUNNING-DOCS-LOCALLY.md b/RUNNING-DOCS-LOCALLY.md index 59c9d8e3..218d5b13 100644 --- 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/get-started/welcome.md b/docs/get-started/welcome.md index f588abfd..0e2cc0fc 100644 --- a/docs/get-started/welcome.md +++ b/docs/get-started/welcome.md @@ -9,20 +9,12 @@ description: Welcome to the Quix Developer documentation. This documentation inc
-- __I'm comfortable on the command line__ +- __Build a pipeline__ --- - Start building your stream processing pipeline on the command line with Quix Streams and the Quix CLI. + Start building your stream processing pipeline on the command line with Quix Streams. [Install Quix Streams :octicons-arrow-right-24:](./install.md) -- __I'd rather use the Cloud__ - - --- - - 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. - - [Quix Cloud Quickstart :octicons-arrow-right-24:](../quix-cloud/quickstart.md) -
\ No newline at end of file diff --git a/overrides/main.html b/overrides/main.html index 9cbff3c7..12e6952f 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -141,7 +141,7 @@
- +
From 72a9089d216864a561fd28c443e1e575d1685a6c Mon Sep 17 00:00:00 2001 From: tbedford Date: Tue, 21 May 2024 16:44:12 +0100 Subject: [PATCH 2/3] [wip] - modify start page --- docs/get-started/welcome.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/get-started/welcome.md b/docs/get-started/welcome.md index 0e2cc0fc..239e5fc2 100644 --- a/docs/get-started/welcome.md +++ b/docs/get-started/welcome.md @@ -7,13 +7,19 @@ description: Welcome to the Quix Developer documentation. This documentation inc

Quix is a complete platform for developing, deploying, and monitoring stream processing pipelines. You develop your pipeline services in Python 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.

+Your Quix workflow: + +1. Develop your applications locally in Python with Quix Streams and the Quix CLI +2. Test your pipeline locally with Quix CLI +3. Deploy to Quix Cloud for scalability and observability +
-- __Build a pipeline__ +- __Get started!__ --- - Start building your stream processing pipeline on the command line with Quix Streams. + Start building your stream processing pipeline locally on the command line with Quix Streams. [Install Quix Streams :octicons-arrow-right-24:](./install.md) From d3fa71828071a95381cadcffc46343f9f06c0e66 Mon Sep 17 00:00:00 2001 From: tbedford Date: Wed, 22 May 2024 14:25:12 +0100 Subject: [PATCH 3/3] [wip] - tweak pitch text --- docs/get-started/welcome.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/get-started/welcome.md b/docs/get-started/welcome.md index 239e5fc2..ba2099a1 100644 --- a/docs/get-started/welcome.md +++ b/docs/get-started/welcome.md @@ -5,13 +5,15 @@ description: Welcome to the Quix Developer documentation. This documentation inc # Welcome -

Quix is a complete platform for developing, deploying, and monitoring stream processing pipelines. You develop your pipeline services in Python 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.

+

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.

+ +## Workflow summary Your Quix workflow: -1. Develop your applications locally in Python with Quix Streams and the Quix CLI -2. Test your pipeline locally with Quix CLI -3. Deploy to Quix Cloud for scalability and observability +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.
@@ -23,4 +25,4 @@ Your Quix workflow: [Install Quix Streams :octicons-arrow-right-24:](./install.md) -
\ No newline at end of file +