general edits (and make rabbit happy)

Author: quinntaylormitchell

docs/src/user-guide/guides/guides-multi-node/multi-node.md

@@ -117,14 +117,14 @@ Check out the quick-start guide for your chosen flavour of CLP to learn how to c
 
 :::{grid-item-card}
 :link: ../../../quick-start/clp-json/main-page
-CLP-JSON
+clp-json
 ^^^
 Compress and search JSON logs.
 :::
 
 :::{grid-item-card}
 :link: ../../../quick-start/clp-text/main-page
-CLP-text
+clp-text
 ^^^
 Compress and search unstructured text logs.
 :::

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 [clp-json quick start guide](../../quick-start/clp-json/main-page).
+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/index.md

@@ -10,16 +10,16 @@ The sections are as follows:
 
 :::{grid-item-card}
 :link: quick-start/index
-Quick start
+Quick-start
 ^^^
-A quick start guide for choosing a flavour of CLP, setting it up, 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/guides-overview
 Guides
 ^^^
-Guides for using CLP in a variety of use cases.
+Guides for using CLP in various use cases.
 :::
 
 :::{grid-item-card}
@@ -46,7 +46,7 @@ Reference docs like format specifications, etc.
 
 :::{toctree}
 :hidden:
-:caption: Quick start
+:caption: quick-start
 
 quick-start/index
 quick-start/setup/main-page

docs/src/user-guide/quick-start/clp-json/main-page.md

@@ -1,6 +1,6 @@
-# CLP-JSON
+# clp-json Quick-start
 
-This page will walk you through how to start up CLP, and also show you how to use CLP to compress and search JSON logs.
+This page will walk you through how to start up CLP, and then use it to compress and search JSON logs.
 
 :::{caution}
 If you're using the `clp-json` release, you can only compress JSON logs.
@@ -55,7 +55,7 @@ To compress logs from object storage, see
 
 ### Sample logs
 
-For some sample logs, check out the open-source [datasets](../../resources/resources-datasets.md).
+For some sample logs, check out the open-source [datasets](../../resources/resources-datasets).
 
 ### Examining compression statistics
 
@@ -145,4 +145,4 @@ sbin/stop-clp.sh
 
 ## More information
 
-You've reached the end of the clp-json quick start guide. For more information on clp-json, visit the [CLP for JSON logs](../../core/core-clp-s) page.
+You've reached the end of the clp-json quick-start guide. For more information on clp-json, visit the [CLP for JSON logs](../../core/core-clp-s) page.

docs/src/user-guide/quick-start/clp-text/main-page.md

@@ -1,9 +1,9 @@
-# CLP-text
+# clp-text Quick-start
 
-This page will walk you through how to start up CLP, and also show you how to use CLP to compress and search unstructured text logs.
+This page will walk you through how to start up CLP, and then use it to compress and search unstructured text logs.
 
 :::{caution}
-If you're using the `clp-text` release, you should only compress unstructured text logs. `clp-text` can compress and search JSON logs as if it was unstructured text, but `clp-text` cannot query individual fields. This limitation will be addressed in a future version of CLP.
+If you're using the `clp-text` release, you should only compress unstructured text logs. `clp-text` is able to compress and search JSON logs as if it was unstructured text, but `clp-text` cannot query individual fields. This limitation will be addressed in a future version of CLP.
 :::
 
 ---
@@ -37,7 +37,7 @@ Compressed logs will be stored in the `/var/bin/archives` directory.
 
 ### Sample logs
 
-For some sample logs, check out the open-source [datasets](../../resources/resources-datasets.md).
+For some sample logs, check out the open-source [datasets](../../resources/resources-datasets).
 
 ### Examining compression statistics
 
@@ -54,13 +54,13 @@ You can search through your logs using queries from the UI or from the command l
 
 Regardless of what method you use to search, you'll need a query to find the logs you're looking for. All unstructured text log queries are written as plain text. 
 
-You can use a couple special characters to make these queries more versatile. `*` can be used as a placeholder for an unknown number of characters, and `?` can be used for a single character. For example, the query
+You can use a couple of special characters to make these queries more versatile. `*` can be used as a placeholder for an unknown number of characters, and `?` can be used for a single character. For example, the query
 
-``` bash
-one * two?three
+```bash
+a*b?c
 ```
 
-would return all logs that contain the sequence of characters "one" followed by any number (even zero) of other characters, followed by "two", followed by one other character, followed by "three".
+would return all logs that contain the character `"a"` followed by any number (including zero) of other characters, followed by `"b"`, followed by one other character, followed by `"c"`.
 
 There are a number of other syntax rules specific to unstructured text queries that you can use to make your searches more powerful and effective. You can read about these syntax rules [here](../../reference/reference-text-search-syntax).
 
@@ -125,4 +125,4 @@ sbin/stop-clp.sh
 
 ## More information
 
-You've reached the end of the clp-text quick start guide. For more information on clp-text, visit the [CLP for unstructured logs](../../core/core-unstructured/index) page.
+You've reached the end of the clp-text quick-start guide. For more information on clp-text, visit the [CLP for unstructured logs](../../core/core-unstructured/index) page.

docs/src/user-guide/quick-start/index.md

@@ -1,6 +1,6 @@
 # Overview
 
-To learn how to use CLP, follow the "Setup" link.
+If you're new to CLP, follow the link below to learn how to set it up.
 
 ::::{grid} 1 1 1 1
 :gutter: 2

docs/src/user-guide/quick-start/setup/main-page.md

@@ -12,7 +12,7 @@ To run properly on your system, CLP requires a few other programs. Before you se
 
 CLP uses Docker to deploy its different components. You can check whether Docker is already installed on your system by running the command
 
-``` bash
+```bash
 docker version
 ```
 
@@ -26,11 +26,11 @@ If you're using Docker Desktop, ensure version 4.34 or higher is installed, and
 
 CLP uses Python to interpret the scripts that coordinate how it runs. Specifically, CLP needs Python version 3.8 or higher. Many Linux distributions come with Python pre-installed, but just to be sure, run the command
 
-``` bash
+```bash
 python3 --version
 ```
 
-If Python isn't on your system, or if the version isn't high enough, follow the instructions [here][Python] to install or upgrade it.
+If Python isn't on your system, or if the version isn't high enough, install or upgrade it.
 
 :::{note}
 If you're planning on deploying CLP on multiple nodes/systems, there are a few other system requirements; check out the [multi-node deployment](../../guides/guides-multi-node/multi-node) page for more details.
@@ -74,7 +74,7 @@ object. For example:
 The log file above contains two log events represented by two JSON objects printed one after the
 other. Whitespace is ignored, so the log events could also appear with no newlines and indentation.
 
-If your logs are JSON logs, download and extract the JSON flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the CLP-JSON portal below.
+If your logs are JSON logs, download and extract the JSON flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the clp-json portal below.
 
 ::::{grid} 1 1 1 1
 :gutter: 2
@@ -83,7 +83,7 @@ If your logs are JSON logs, download and extract the JSON flavour tarball from t
 :link: ../clp-json/main-page
 CLP for JSON logs
 ^^^
-Learn how to start up CLP-JSON, and begin compressing and searching JSON logs.
+Learn how to start up clp-json, and begin compressing and searching JSON logs.
 :::
 ::::
 
@@ -112,7 +112,7 @@ Caused by: java.net.UnknownHostException: i-e5d112ea
 The log file above contains two log events, both beginning with a timestamp. The first is a single
 line while the second contains multiple lines.
 
-If your logs are unstructured text logs, download and extract the unstructured text flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the CLP-text portal below.
+If your logs are unstructured text logs, download and extract the unstructured text flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the clp-text portal below.
 
 ::::{grid} 1 1 1 1
 :gutter: 2
@@ -121,12 +121,11 @@ If your logs are unstructured text logs, download and extract the unstructured t
 :link: ../clp-text/main-page
 CLP for unstructured logs
 ^^^
-Learn how to start up CLP-text, and begin compressing and searching unstructured text logs.
+Learn how to start up clp-text, and begin compressing and searching unstructured text logs.
 :::
 ::::
 
 [Docker]: https://docs.docker.com/engine/install/
 [docker-non-root]: https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user
 [docker-desktop-host-networking]: https://docs.docker.com/engine/network/drivers/host/#docker-desktop
-[Python]: https://www.geeksforgeeks.org/how-to-install-python-on-linux/
 [clp-releases]: https://github.com/y-scope/clp/releases