Skip to content

Commit 2692e50

Browse files
general edits (and make rabbit happy)
1 parent 596c70c commit 2692e50

File tree

7 files changed

+28
-29
lines changed

7 files changed

+28
-29
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,14 @@ Check out the quick-start guide for your chosen flavour of CLP to learn how to c
117117

118118
:::{grid-item-card}
119119
:link: ../../../quick-start/clp-json/main-page
120-
CLP-JSON
120+
clp-json
121121
^^^
122122
Compress and search JSON logs.
123123
:::
124124

125125
:::{grid-item-card}
126126
:link: ../../../quick-start/clp-text/main-page
127-
CLP-text
127+
clp-text
128128
^^^
129129
Compress and search unstructured text logs.
130130
:::

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Using CLP with object storage
22

33
To compress logs from S3, follow the steps in the section below. For all other operations, you
4-
should be able to use CLP as described in the [clp-json quick start guide](../../quick-start/clp-json/main-page).
4+
should be able to use CLP as described in the [clp-json quick-start guide](../../quick-start/clp-json/main-page).
55

66
## Compressing logs from S3
77

docs/src/user-guide/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ The sections are as follows:
1010

1111
:::{grid-item-card}
1212
:link: quick-start/index
13-
Quick start
13+
Quick-start
1414
^^^
15-
A quick start guide for choosing a flavour of CLP, setting it up, compressing your logs, and searching them.
15+
A quick-start guide for choosing a flavour of CLP, setting it up, compressing your logs, and searching them.
1616
:::
1717

1818
:::{grid-item-card}
1919
:link: guides/guides-overview
2020
Guides
2121
^^^
22-
Guides for using CLP in a variety of use cases.
22+
Guides for using CLP in various use cases.
2323
:::
2424

2525
:::{grid-item-card}
@@ -46,7 +46,7 @@ Reference docs like format specifications, etc.
4646

4747
:::{toctree}
4848
:hidden:
49-
:caption: Quick start
49+
:caption: quick-start
5050

5151
quick-start/index
5252
quick-start/setup/main-page

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# CLP-JSON
1+
# clp-json Quick-start
22

3-
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.
3+
This page will walk you through how to start up CLP, and then use it to compress and search JSON logs.
44

55
:::{caution}
66
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
5555

5656
### Sample logs
5757

58-
For some sample logs, check out the open-source [datasets](../../resources/resources-datasets.md).
58+
For some sample logs, check out the open-source [datasets](../../resources/resources-datasets).
5959

6060
### Examining compression statistics
6161

@@ -145,4 +145,4 @@ sbin/stop-clp.sh
145145

146146
## More information
147147

148-
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.
148+
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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# CLP-text
1+
# clp-text Quick-start
22

3-
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.
3+
This page will walk you through how to start up CLP, and then use it to compress and search unstructured text logs.
44

55
:::{caution}
6-
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.
6+
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.
77
:::
88

99
---
@@ -37,7 +37,7 @@ Compressed logs will be stored in the `/var/bin/archives` directory.
3737

3838
### Sample logs
3939

40-
For some sample logs, check out the open-source [datasets](../../resources/resources-datasets.md).
40+
For some sample logs, check out the open-source [datasets](../../resources/resources-datasets).
4141

4242
### Examining compression statistics
4343

@@ -54,13 +54,13 @@ You can search through your logs using queries from the UI or from the command l
5454

5555
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.
5656

57-
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
57+
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
5858

59-
``` bash
60-
one * two?three
59+
```bash
60+
a*b?c
6161
```
6262

63-
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".
63+
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"`.
6464

6565
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).
6666

@@ -125,4 +125,4 @@ sbin/stop-clp.sh
125125

126126
## More information
127127

128-
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.
128+
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview
22

3-
To learn how to use CLP, follow the "Setup" link.
3+
If you're new to CLP, follow the link below to learn how to set it up.
44

55
::::{grid} 1 1 1 1
66
:gutter: 2

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To run properly on your system, CLP requires a few other programs. Before you se
1212

1313
CLP uses Docker to deploy its different components. You can check whether Docker is already installed on your system by running the command
1414

15-
``` bash
15+
```bash
1616
docker version
1717
```
1818

@@ -26,11 +26,11 @@ If you're using Docker Desktop, ensure version 4.34 or higher is installed, and
2626

2727
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
2828

29-
``` bash
29+
```bash
3030
python3 --version
3131
```
3232

33-
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.
33+
If Python isn't on your system, or if the version isn't high enough, install or upgrade it.
3434

3535
:::{note}
3636
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:
7474
The log file above contains two log events represented by two JSON objects printed one after the
7575
other. Whitespace is ignored, so the log events could also appear with no newlines and indentation.
7676

77-
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.
77+
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.
7878

7979
::::{grid} 1 1 1 1
8080
:gutter: 2
@@ -83,7 +83,7 @@ If your logs are JSON logs, download and extract the JSON flavour tarball from t
8383
:link: ../clp-json/main-page
8484
CLP for JSON logs
8585
^^^
86-
Learn how to start up CLP-JSON, and begin compressing and searching JSON logs.
86+
Learn how to start up clp-json, and begin compressing and searching JSON logs.
8787
:::
8888
::::
8989

@@ -112,7 +112,7 @@ Caused by: java.net.UnknownHostException: i-e5d112ea
112112
The log file above contains two log events, both beginning with a timestamp. The first is a single
113113
line while the second contains multiple lines.
114114

115-
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.
115+
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.
116116

117117
::::{grid} 1 1 1 1
118118
:gutter: 2
@@ -121,12 +121,11 @@ If your logs are unstructured text logs, download and extract the unstructured t
121121
:link: ../clp-text/main-page
122122
CLP for unstructured logs
123123
^^^
124-
Learn how to start up CLP-text, and begin compressing and searching unstructured text logs.
124+
Learn how to start up clp-text, and begin compressing and searching unstructured text logs.
125125
:::
126126
::::
127127

128128
[Docker]: https://docs.docker.com/engine/install/
129129
[docker-non-root]: https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user
130130
[docker-desktop-host-networking]: https://docs.docker.com/engine/network/drivers/host/#docker-desktop
131-
[Python]: https://www.geeksforgeeks.org/how-to-install-python-on-linux/
132131
[clp-releases]: https://github.com/y-scope/clp/releases

0 commit comments

Comments
 (0)