docs: Restructure quick-start guide into separate end-to-end guides for clp-json and clp-text.

docs/src/dev-guide/design-kv-ir-streams/background.md

@@ -11,7 +11,7 @@ We discuss each below.
 
 ## clp-s compression
 
-At a high-level, [clp-s](../../user-guide/core-clp-s.md) compresses log events into what we call
+At a high-level, [clp-s](../../user-guide/core/core-clp-s.md) compresses log events into what we call
 archives. Depending on the configured size-threshold for each archive, a set of log events may be
 compressed into one or more archives. The archive format is designed so that each archive is
 self-contained and independent, allowing archives to be searched concurrently.
@@ -318,7 +318,7 @@ the archive is complete.
 
 ## Parsing & encoding unstructured text
 
-clp-s uses [clp](../../user-guide/core-unstructured/clp.md)'s algorithm to parse and encode
+clp-s uses [clp](../../user-guide/core/core-unstructured/clp.md)'s algorithm to parse and encode
 unstructured text. Unstructured text is a string that contains zero or more variable values
 interspersed with non-variable (static) text. For example, in [Figure 1](#figure-1), log event
 #1's `message` value is unstructured text containing the variable values `task_1` and `2`. At a

docs/src/index.md

@@ -109,7 +109,7 @@ dev-guide/index
 [clp-ffi-py]: https://github.com/y-scope/clp-ffi-py
 [clp-loglib-py]: https://github.com/y-scope/clp-loglib-py
 [clp-paper]: https://www.usenix.org/system/files/osdi21-rodrigues.pdf
-[datasets]: user-guide/resources-datasets
+[datasets]: user-guide/resources/resources-datasets
 [feature-req]: https://github.com/y-scope/clp/issues/new?assignees=&labels=enhancement&template=feature-request.yml
 [log-surgeon]: https://github.com/y-scope/log-surgeon
 [log-viewer]: https://github.com/y-scope/yscope-log-viewer

docs/src/user-guide/core-clp-s.md → docs/src/user-guide/core/core-clp-s.md

@@ -78,7 +78,7 @@ Usage:
 ```
 
 * `archives-dir` is a directory containing archives.
-* `kql-query` is a [KQL](reference-json-search-syntax) query.
+* `kql-query` is a [KQL](../reference/reference-json-search-syntax) query.
 * `options` allow you to specify things like a specific archive (from within `archives-dir`) to
   search (`--archive-id <archive-id>`).
   * For a complete list, run `./clp-s s --help`
@@ -124,4 +124,4 @@ compressed data:**
 * The input directory structure is not preserved and during decompression all files are written to
   the same file.
 * In addition, there are a few limitations, related to querying arrays, described in the search
-  syntax [reference](reference-json-search-syntax).
+  syntax [reference](../reference/reference-json-search-syntax).

docs/src/user-guide/core-unstructured/clp.md → docs/src/user-guide/core/core-unstructured/clp.md

@@ -17,7 +17,7 @@ Usage:
   * You can use the same directory repeatedly and `clp` will add to the compressed logs within.
 * `input-path` is any plain-text log file or directory containing such files.
 * `options` allow you to specify things like a path to a custom
-  [schema](../reference-unstructured-schema-file) file (`--schema-path <file-path>`).
+  [schema](../../reference/reference-unstructured-schema-file) file (`--schema-path <file-path>`).
   * For a complete list, run `./clp c --help`
 
 ### Examples

docs/src/user-guide/quick-start-cluster-setup/multi-node.md → docs/src/user-guide/guides/guides-multi-node/multi-node.md

@@ -110,8 +110,25 @@ Where `<component>` is the name of the component in the groups above.
 
 ## Using CLP
 
-Check out the [compression](../quick-start-compression/index) and
-[search](../quick-start-search/index) guides to compress and search your logs.
+Check out the quick-start guide for your chosen flavour of CLP to learn how to compress and search your logs.
+
+::::{grid} 1 1 2 2
+:gutter: 2
+
+:::{grid-item-card}
+:link: ../../../quick-start/clp-json/main-page
+CLP-JSON
+^^^
+Compress and search JSON logs.
+:::
+
+:::{grid-item-card}
+:link: ../../../quick-start/clp-text/main-page
+CLP-text
+^^^
+Compress and search unstructured text logs.
+:::
+::::
 
 ## Stopping CLP
 

docs/src/user-guide/guides-overview.md → docs/src/user-guide/guides/guides-overview.md

@@ -11,4 +11,11 @@ Using object storage
 ^^^
 Using CLP to ingest logs from object storage and store archives on object storage.
 :::
+
+:::{grid-item-card}
+:link: guides-multi-node/multi-node
+Multi-node deployment
+^^^
+Learn how to deploy CLP across multiple systems/nodes.
+:::
 ::::

docs/src/user-guide/guides-using-object-storage/clp-usage.md → docs/src/user-guide/guides/guides-using-object-storage/clp-usage.md

@@ -1,7 +1,7 @@
 # Using CLP with object storage
 
 To compress logs from S3, follow the steps in the section below. For all other operations, you
-should be able to use CLP as described in the [quick start](../quick-start-overview.md) guide.
+should be able to use CLP as described in the [clp-json quick start guide](../../quick-start/clp-json/main-page).
 
 ## Compressing logs from S3
 

docs/src/user-guide/guides-using-object-storage/index.md → docs/src/user-guide/guides/guides-using-object-storage/index.md

@@ -11,7 +11,7 @@ to use object storage for any combination of the three use cases (e.g., compress
 cache the stream files on S3, but store archives on the local filesystem).
 
 :::{note}
-Currently, only the [clp-json][release-choices] release supports object storage. Support for
+Currently, only the [clp-json][release-choices] flavour supports object storage. Support for
 `clp-text` will be added in a future release.
 :::
 
@@ -23,7 +23,7 @@ will be added in a future release.
 ## Prerequisites
 
 1. This guide assumes you're able to configure, start, stop, and use a CLP cluster as described in
-   the [quick-start guide](../quick-start-overview.md).
+   the [clp-json quick-start guide][release-choices].
 2. An S3 bucket and [key prefix][aws-key-prefixes] containing the logs you wish to compress.
 3. An S3 bucket and key prefix where you wish to store compressed archives.
 4. An S3 bucket and key prefix where you wish to cache stream files.
@@ -136,4 +136,4 @@ clp-usage
 [aws-iam-roles]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html
 [aws-key-prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
 [aws-sts-credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html
-[release-choices]: ../quick-start-cluster-setup/index.md#choosing-a-release
+[release-choices]: ../../quick-start/clp-json/main-page

docs/src/user-guide/index.md

@@ -9,35 +9,35 @@ The sections are as follows:
 :gutter: 2
 
 :::{grid-item-card}
-:link: quick-start-overview
+:link: quick-start/index
 Quick start
 ^^^
-A quick start guide for setting up a CLP cluster, compressing your logs, and searching them.
+A quick start guide for choosing a flavour of CLP, setting it up, compressing your logs, and searching them.
 :::
 
 :::{grid-item-card}
-:link: guides-overview
+:link: guides/guides-overview
 Guides
 ^^^
 Guides for using CLP in a variety of use cases.
 :::
 
 :::{grid-item-card}
-:link: core-overview
+:link: core/core-overview
 Core
 ^^^
 Docs about CLP's core component for compressing, decompressing, and searching logs.
 :::
 
 :::{grid-item-card}
-:link: resources-datasets
+:link: resources/resources-datasets
 Resources
 ^^^
 Resources like log datasets, etc.
 :::
 
 :::{grid-item-card}
-:link: reference-json-search-syntax
+:link: reference/index
 Reference
 ^^^
 Reference docs like format specifications, etc.
@@ -48,44 +48,48 @@ Reference docs like format specifications, etc.
 :hidden:
 :caption: Quick start
 
-quick-start-overview
-quick-start-cluster-setup/index
-quick-start-compression/index
-quick-start-search/index
+quick-start/index
+quick-start/setup/main-page
+quick-start/clp-json/main-page
+quick-start/clp-text/main-page
+
 :::
 
 :::{toctree}
 :hidden:
 :caption: Guides
 :glob:
 
-guides-overview
-guides-using-object-storage/index
+guides/guides-overview
+guides/guides-using-object-storage/index
+guides/guides-multi-node/multi-node
+
 :::
 
 :::{toctree}
 :hidden:
 :caption: Core
 :glob:
 
-core-overview
-core-container
-core-clp-s
-core-unstructured/index
+core/core-overview
+core/core-container
+core/core-clp-s
+core/core-unstructured/index
 :::
 
 :::{toctree}
 :hidden:
 :caption: Resources
 
-resources-datasets
+resources/resources-datasets
 :::
 
 :::{toctree}
 :hidden:
 :caption: Reference
 
-reference-json-search-syntax
-reference-text-search-syntax
-reference-unstructured-schema-file
+reference/index
+reference/reference-json-search-syntax
+reference/reference-text-search-syntax
+reference/reference-unstructured-schema-file
 :::