Skip to content
Merged
Show file tree
Hide file tree
Changes from 39 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
d4f716d
Added new directories and files to support new quick-start structure
quinntaylormitchell Jun 4, 2025
28df225
Add 'setup' page in Quick-start
quinntaylormitchell Jun 4, 2025
05759bc
Add clp-json main page and connect to setup page
quinntaylormitchell Jun 4, 2025
0eaa516
Add clp-text main page and connect to setup page
quinntaylormitchell Jun 5, 2025
83e1c98
Modify caution message in clp-json and clp-text
quinntaylormitchell Jun 5, 2025
2bd5ff8
Move multi-node development page to Guides; add Guides directory to a…
quinntaylormitchell Jun 5, 2025
e5be2a3
Removed obsolete quick-start docs; the information has been integrate…
quinntaylormitchell Jun 5, 2025
f60aff2
Restructured directories to better reflect website structure
quinntaylormitchell Jun 5, 2025
3e29ed1
Add landing page for 'Reference'
quinntaylormitchell Jun 5, 2025
596c70c
Add link at end of clp-json and clp-text quickstart pages to their re…
quinntaylormitchell Jun 5, 2025
2692e50
general edits (and make rabbit happy)
quinntaylormitchell Jun 5, 2025
62d38ea
more rabbit edits
quinntaylormitchell Jun 5, 2025
ab525d2
Fix broken link
quinntaylormitchell Jun 5, 2025
23919cc
Reverted changes unrelated to the separation of clp-json and clp-text
quinntaylormitchell Jun 5, 2025
04f315e
Update docs/src/user-guide/guides/guides-overview.md
quinntaylormitchell Jun 13, 2025
721cc6c
Small changes to address Devin's review
quinntaylormitchell Jun 13, 2025
36c343a
Merge branch 'docs-json-text-separation' of https://github.com/quinnt…
quinntaylormitchell Jun 13, 2025
5a89f43
Address Kirk's comments
quinntaylormitchell Jun 18, 2025
387a56d
Update docs/src/user-guide/quick-start/overview.md
quinntaylormitchell Jun 18, 2025
e2f3304
Fix double line
quinntaylormitchell Jun 18, 2025
e46dc23
Deduplicate content that's repeated between both clp-json and clp-tex…
quinntaylormitchell Jun 18, 2025
22f0d89
Address rabbit comments
quinntaylormitchell Jun 18, 2025
0799774
Lint
quinntaylormitchell Jun 18, 2025
07cde43
Restore content that had been deduplicated with 'include' command
quinntaylormitchell Jun 23, 2025
5ba7a0f
Address Kirk's comments
quinntaylormitchell Jun 23, 2025
8ccbaf0
Use American English spelling (only modified files in quick-start fol…
quinntaylormitchell Jun 23, 2025
1e8b6a5
Change formatting to comply with markdownlintcli2
quinntaylormitchell Jun 23, 2025
7b8bf61
Address rabbit comments
quinntaylormitchell Jun 23, 2025
734edd4
Fix before/after explanation for <epoch-timestamp-millis> statements
quinntaylormitchell Jun 23, 2025
223e454
Rabbit comments
quinntaylormitchell Jun 23, 2025
a49773f
Address Kirk's comments
quinntaylormitchell Jun 30, 2025
7e376aa
Correct file extension
quinntaylormitchell Jun 30, 2025
31ee23b
Address Kirk's comments
quinntaylormitchell Jul 2, 2025
e302d38
Rabbit/lint
quinntaylormitchell Jul 2, 2025
f3a538e
Make changes to clp-text.md to mirror changes in clp-json.md
quinntaylormitchell Jul 3, 2025
61eedc3
Lint changes
quinntaylormitchell Jul 3, 2025
5fed1f2
Rabbit
quinntaylormitchell Jul 3, 2025
a10aa54
Address Kirk's comments
quinntaylormitchell Jul 3, 2025
6d6c779
Address Kirk's comments
quinntaylormitchell Jul 3, 2025
0db424f
Rabbit
quinntaylormitchell Jul 3, 2025
ab2181d
Address Kirk's comment
quinntaylormitchell Jul 3, 2025
60704d9
Merge branch 'main' into docs-json-text-separation
kirkrodrigues Jul 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,26 @@ 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.
To learn how to compress and search your logs, check out the quick-start guide that corresponds to
the flavor of CLP you're running:

::::{grid} 1 1 2 2
:gutter: 2

:::{grid-item-card}
:link: quick-start/clp-json
Using clp-json
^^^
How to compress and search JSON logs.
:::

:::{grid-item-card}
:link: quick-start/clp-text
Using clp-text
^^^
How to compress and search unstructured text logs.
:::
::::

## Stopping CLP

Expand Down
7 changes: 7 additions & 0 deletions docs/src/user-guide/guides-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 deployment
^^^
How to deploy CLP across multiple nodes.
:::
::::
Original file line number Diff line number Diff line change
@@ -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).

## Compressing logs from S3

Expand Down
10 changes: 5 additions & 5 deletions docs/src/user-guide/guides-using-object-storage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ 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
`clp-text` will be added in a future release.
Currently, only [clp-json][release-choices] supports object storage. Support for `clp-text` will be
added in a future release.
:::

:::{note}
Expand All @@ -22,8 +22,8 @@ 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).
1. This guide assumes you're able to configure, start, stop, and use CLP as described in the
[clp-json quick-start guide](../quick-start/clp-json.md).
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.
Expand Down Expand Up @@ -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/index.md#choosing-a-flavor
15 changes: 8 additions & 7 deletions docs/src/user-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,18 @@ 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 flavor of CLP, setting it up, compressing your logs, and
searching them.
:::

:::{grid-item-card}
:link: guides-overview
Guides
^^^
Guides for using CLP in a variety of use cases.
Guides for using CLP in various use cases.
:::

:::{grid-item-card}
Expand Down Expand Up @@ -48,10 +49,9 @@ 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/clp-json
quick-start/clp-text
:::

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

guides-overview
guides-using-object-storage/index
guides-multi-node
:::

:::{toctree}
Expand Down
100 changes: 0 additions & 100 deletions docs/src/user-guide/quick-start-cluster-setup/index.md

This file was deleted.

40 changes: 0 additions & 40 deletions docs/src/user-guide/quick-start-cluster-setup/single-node.md

This file was deleted.

33 changes: 0 additions & 33 deletions docs/src/user-guide/quick-start-compression/index.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs/src/user-guide/quick-start-compression/json.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/src/user-guide/quick-start-compression/text.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/src/user-guide/quick-start-overview.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/src/user-guide/quick-start-search/cli-search.md

This file was deleted.

Loading