Skip to content

Commit b1121c0

Browse files
quinntaylormitchellgibber9809kirkrodrigues
authored
docs: Restructure quick-start guide into separate end-to-end guides for clp-json and clp-text. (#968)
Co-authored-by: Devin Gibson <[email protected]> Co-authored-by: kirkrodrigues <[email protected]>
1 parent c74bbd8 commit b1121c0

File tree

18 files changed

+517
-346
lines changed

18 files changed

+517
-346
lines changed

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

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,26 @@ Where `<component>` is the name of the component in the groups above.
110110

111111
## Using CLP
112112

113-
Check out the [compression](../quick-start-compression/index) and
114-
[search](../quick-start-search/index) guides to compress and search your logs.
113+
To learn how to compress and search your logs, check out the quick-start guide that corresponds to
114+
the flavor of CLP you're running:
115+
116+
::::{grid} 1 1 2 2
117+
:gutter: 2
118+
119+
:::{grid-item-card}
120+
:link: quick-start/clp-json
121+
Using clp-json
122+
^^^
123+
How to compress and search JSON logs.
124+
:::
125+
126+
:::{grid-item-card}
127+
:link: quick-start/clp-text
128+
Using clp-text
129+
^^^
130+
How to compress and search unstructured text logs.
131+
:::
132+
::::
115133

116134
## Stopping CLP
117135

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,11 @@ Using object storage
1111
^^^
1212
Using CLP to ingest logs from object storage and store archives on object storage.
1313
:::
14+
15+
:::{grid-item-card}
16+
:link: guides-multi-node
17+
Multi-node deployment
18+
^^^
19+
How to deploy CLP across multiple nodes.
20+
:::
1421
::::

docs/src/user-guide/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 [quick start](../quick-start-overview.md) guide.
4+
should be able to use CLP as described in the [clp-json quick-start guide](../quick-start/clp-json).
55

66
## Compressing logs from S3
77

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ to use object storage for any combination of the three use cases (e.g., compress
1111
cache the stream files on S3, but store archives on the local filesystem).
1212

1313
:::{note}
14-
Currently, only the [clp-json][release-choices] release supports object storage. Support for
15-
`clp-text` will be added in a future release.
14+
Currently, only [clp-json][release-choices] supports object storage. Support for `clp-text` will be
15+
added in a future release.
1616
:::
1717

1818
:::{note}
@@ -22,8 +22,8 @@ will be added in a future release.
2222

2323
## Prerequisites
2424

25-
1. This guide assumes you're able to configure, start, stop, and use a CLP cluster as described in
26-
the [quick-start guide](../quick-start-overview.md).
25+
1. This guide assumes you're able to configure, start, stop, and use CLP as described in the
26+
[clp-json quick-start guide](../quick-start/clp-json.md).
2727
2. An S3 bucket and [key prefix][aws-key-prefixes] containing the logs you wish to compress.
2828
3. An S3 bucket and key prefix where you wish to store compressed archives.
2929
4. An S3 bucket and key prefix where you wish to cache stream files.
@@ -136,4 +136,4 @@ clp-usage
136136
[aws-iam-roles]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html
137137
[aws-key-prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
138138
[aws-sts-credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html
139-
[release-choices]: ../quick-start-cluster-setup/index.md#choosing-a-release
139+
[release-choices]: ../quick-start/index.md#choosing-a-flavor

docs/src/user-guide/index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,18 @@ The sections are as follows:
99
:gutter: 2
1010

1111
:::{grid-item-card}
12-
:link: quick-start-overview
12+
:link: quick-start/index
1313
Quick start
1414
^^^
15-
A quick start guide for setting up a CLP cluster, compressing your logs, and searching them.
15+
A quick-start guide for choosing a flavor of CLP, setting it up, compressing your logs, and
16+
searching them.
1617
:::
1718

1819
:::{grid-item-card}
1920
:link: guides-overview
2021
Guides
2122
^^^
22-
Guides for using CLP in a variety of use cases.
23+
Guides for using CLP in various use cases.
2324
:::
2425

2526
:::{grid-item-card}
@@ -48,10 +49,9 @@ Reference docs like format specifications, etc.
4849
:hidden:
4950
:caption: Quick start
5051

51-
quick-start-overview
52-
quick-start-cluster-setup/index
53-
quick-start-compression/index
54-
quick-start-search/index
52+
quick-start/index
53+
quick-start/clp-json
54+
quick-start/clp-text
5555
:::
5656

5757
:::{toctree}
@@ -61,6 +61,7 @@ quick-start-search/index
6161

6262
guides-overview
6363
guides-using-object-storage/index
64+
guides-multi-node
6465
:::
6566

6667
:::{toctree}

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

Lines changed: 0 additions & 100 deletions
This file was deleted.

docs/src/user-guide/quick-start-cluster-setup/single-node.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

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

Lines changed: 0 additions & 33 deletions
This file was deleted.

docs/src/user-guide/quick-start-compression/json.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

docs/src/user-guide/quick-start-compression/text.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)