diff --git a/README.md b/README.md index 39d9be5a4f..84c10db0f8 100644 --- a/README.md +++ b/README.md @@ -99,16 +99,16 @@ If you would like a feature or want to report a bug, please file an issue and we [badge-discord]: https://img.shields.io/discord/1377353873068392580?style=flat&logo=discord&logoColor=white&label=Discord&labelColor=%235561f5 [badge-zulip]: https://img.shields.io/badge/Zulip-yscope--clp-1888FA?logo=zulip [bug-report]: https://github.com/y-scope/clp/issues/new?assignees=&labels=bug&template=bug-report.yml -[build-package]: http://docs.yscope.com/clp/main/dev-guide/building-package +[build-package]: http://docs.yscope.com/clp/main/dev-docs/building-package [clp-docs]: https://docs.yscope.com/clp/main [clp-ffi-go]: https://github.com/y-scope/clp-ffi-go [clp-ffi-py]: https://github.com/y-scope/clp-ffi-py [clp-loglib-py]: https://github.com/y-scope/clp-loglib-py [clp-paper-21]: https://www.usenix.org/system/files/osdi21-rodrigues.pdf -[clp-paper-24]: https://www.usenix.org/system/files/osdi24-wang-rui.pdf -[core]: http://docs.yscope.com/clp/main/dev-guide/components-core -[core-container]: http://docs.yscope.com/clp/main/user-guide/core-container -[datasets]: https://docs.yscope.com/clp/main/user-guide/resources-datasets +[clp-paper-24]: https://www.usenix.org/system/files/osdi24-wang-rui.pdf +[core]: http://docs.yscope.com/clp/main/dev-docs/components-core +[core-container]: http://docs.yscope.com/clp/main/user-docs/core-container +[datasets]: https://docs.yscope.com/clp/main/user-docs/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 diff --git a/components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py b/components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py index 217db17676..97acb2e9b6 100644 --- a/components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py +++ b/components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py @@ -133,7 +133,7 @@ def create_datasets_table(db_cursor, table_prefix: str) -> None: """ # For a description of the table, see - # `../../../docs/src/dev-guide/design-metadata-db.md` + # `../../../docs/src/dev-docs/design-metadata-db.md` db_cursor.execute( f""" CREATE TABLE IF NOT EXISTS `{get_datasets_table_name(table_prefix)}` ( diff --git a/components/core/README.md b/components/core/README.md index b947f4b9c5..5f097db2f9 100644 --- a/components/core/README.md +++ b/components/core/README.md @@ -4,5 +4,5 @@ CLP core is the low-level component that performs compression, decompression, an See the docs below for more details: -* [Building](https://docs.yscope.com/clp/main/dev-guide/components-core) -* [Running](https://docs.yscope.com/clp/main/user-guide/core-overview) +* [Building](https://docs.yscope.com/clp/main/dev-docs/components-core) +* [Running](https://docs.yscope.com/clp/main/user-docs/core-overview) diff --git a/components/core/src/clp/ffi/search/CompositeWildcardToken.cpp b/components/core/src/clp/ffi/search/CompositeWildcardToken.cpp index b36126ebd6..8fc0845e32 100644 --- a/components/core/src/clp/ffi/search/CompositeWildcardToken.cpp +++ b/components/core/src/clp/ffi/search/CompositeWildcardToken.cpp @@ -139,7 +139,7 @@ bool CompositeWildcardToken::generate_next_interpretation() * into two tokens at the delimiter. * - Finally, if a WildcardToken is delimited by a '*'-delimiter-wildcard, then the '*' should be * included in the WildcardToken (see the generalization in - * /dev-guide/design-parsing-wildcard-queries). + * /dev-docs/design-parsing-wildcard-queries). * * Algorithm: * - To implement this algorithm, we need to search the CompositeWildcardToken for every substring diff --git a/components/core/src/glt/ffi/search/CompositeWildcardToken.cpp b/components/core/src/glt/ffi/search/CompositeWildcardToken.cpp index b8194e4b25..8ddf1c9e58 100644 --- a/components/core/src/glt/ffi/search/CompositeWildcardToken.cpp +++ b/components/core/src/glt/ffi/search/CompositeWildcardToken.cpp @@ -139,7 +139,7 @@ bool CompositeWildcardToken::generate_next_interpretation() * into two tokens at the delimiter. * - Finally, if a WildcardToken is delimited by a '*'-delimiter-wildcard, then the '*' should be * included in the WildcardToken (see the generalization in - * /dev-guide/design-parsing-wildcard-queries). + * /dev-docs/design-parsing-wildcard-queries). * * Algorithm: * - To implement this algorithm, we need to search the CompositeWildcardToken for every substring diff --git a/components/package-template/src/README.md b/components/package-template/src/README.md index 173f9d927d..23bd77d30a 100644 --- a/components/package-template/src/README.md +++ b/components/package-template/src/README.md @@ -5,4 +5,4 @@ compressed data without decompression. CLP's compression ratio is significantly general-purpose compressors like gzip. For setup and usage instructions, see -https://docs.yscope.com/clp/main/user-guide/quick-start-overview +https://docs.yscope.com/clp/main/user-docs/quick-start-overview diff --git a/components/webui/README.md b/components/webui/README.md index 299000819d..4d9f6428e0 100644 --- a/components/webui/README.md +++ b/components/webui/README.md @@ -4,4 +4,4 @@ The web interface for the CLP package. See the [docs] for more details. -[docs]: https://docs.yscope.com/clp/main/dev-guide/components-webui +[docs]: https://docs.yscope.com/clp/main/dev-docs/components-webui diff --git a/docs/src/dev-guide/building-package.md b/docs/src/dev-docs/building-package.md similarity index 100% rename from docs/src/dev-guide/building-package.md rename to docs/src/dev-docs/building-package.md diff --git a/docs/src/dev-guide/components-core/centos-stream-9-deps-install.md b/docs/src/dev-docs/components-core/centos-stream-9-deps-install.md similarity index 100% rename from docs/src/dev-guide/components-core/centos-stream-9-deps-install.md rename to docs/src/dev-docs/components-core/centos-stream-9-deps-install.md diff --git a/docs/src/dev-guide/components-core/index.md b/docs/src/dev-docs/components-core/index.md similarity index 100% rename from docs/src/dev-guide/components-core/index.md rename to docs/src/dev-docs/components-core/index.md diff --git a/docs/src/dev-guide/components-core/macos-deps-install.md b/docs/src/dev-docs/components-core/macos-deps-install.md similarity index 100% rename from docs/src/dev-guide/components-core/macos-deps-install.md rename to docs/src/dev-docs/components-core/macos-deps-install.md diff --git a/docs/src/dev-guide/components-core/regex-utils.md b/docs/src/dev-docs/components-core/regex-utils.md similarity index 100% rename from docs/src/dev-guide/components-core/regex-utils.md rename to docs/src/dev-docs/components-core/regex-utils.md diff --git a/docs/src/dev-guide/components-core/ubuntu-jammy-deps-install.md b/docs/src/dev-docs/components-core/ubuntu-jammy-deps-install.md similarity index 100% rename from docs/src/dev-guide/components-core/ubuntu-jammy-deps-install.md rename to docs/src/dev-docs/components-core/ubuntu-jammy-deps-install.md diff --git a/docs/src/dev-guide/components-webui.md b/docs/src/dev-docs/components-webui.md similarity index 100% rename from docs/src/dev-guide/components-webui.md rename to docs/src/dev-docs/components-webui.md diff --git a/docs/src/dev-guide/contributing-getting-started.md b/docs/src/dev-docs/contributing-getting-started.md similarity index 100% rename from docs/src/dev-guide/contributing-getting-started.md rename to docs/src/dev-docs/contributing-getting-started.md diff --git a/docs/src/dev-guide/contributing-linting.md b/docs/src/dev-docs/contributing-linting.md similarity index 100% rename from docs/src/dev-guide/contributing-linting.md rename to docs/src/dev-docs/contributing-linting.md diff --git a/docs/src/dev-guide/design-kv-ir-streams/auto-gen-kv-pairs.md b/docs/src/dev-docs/design-kv-ir-streams/auto-gen-kv-pairs.md similarity index 100% rename from docs/src/dev-guide/design-kv-ir-streams/auto-gen-kv-pairs.md rename to docs/src/dev-docs/design-kv-ir-streams/auto-gen-kv-pairs.md diff --git a/docs/src/dev-guide/design-kv-ir-streams/background.md b/docs/src/dev-docs/design-kv-ir-streams/background.md similarity index 98% rename from docs/src/dev-guide/design-kv-ir-streams/background.md rename to docs/src/dev-docs/design-kv-ir-streams/background.md index b7a86a21b3..9f8230b1bb 100644 --- a/docs/src/dev-guide/design-kv-ir-streams/background.md +++ b/docs/src/dev-docs/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-docs/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-docs/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 diff --git a/docs/src/dev-guide/design-kv-ir-streams/index.md b/docs/src/dev-docs/design-kv-ir-streams/index.md similarity index 100% rename from docs/src/dev-guide/design-kv-ir-streams/index.md rename to docs/src/dev-docs/design-kv-ir-streams/index.md diff --git a/docs/src/dev-guide/design-metadata-db.md b/docs/src/dev-docs/design-metadata-db.md similarity index 100% rename from docs/src/dev-guide/design-metadata-db.md rename to docs/src/dev-docs/design-metadata-db.md diff --git a/docs/src/dev-guide/design-parsing-wildcard-queries.md b/docs/src/dev-docs/design-parsing-wildcard-queries.md similarity index 100% rename from docs/src/dev-guide/design-parsing-wildcard-queries.md rename to docs/src/dev-docs/design-parsing-wildcard-queries.md diff --git a/docs/src/dev-guide/design-project-structure.md b/docs/src/dev-docs/design-project-structure.md similarity index 100% rename from docs/src/dev-guide/design-project-structure.md rename to docs/src/dev-docs/design-project-structure.md diff --git a/docs/src/dev-guide/index.md b/docs/src/dev-docs/index.md similarity index 90% rename from docs/src/dev-guide/index.md rename to docs/src/dev-docs/index.md index ae892e5707..5372121755 100644 --- a/docs/src/dev-guide/index.md +++ b/docs/src/dev-docs/index.md @@ -1,6 +1,6 @@ -# Developer guide +# Developer docs -This guide contains docs useful for developing CLP. Use the left sidebar (if it's hidden, click the +These docs are useful in developing CLP. Use the left sidebar (if it's hidden, click the icon) to navigate to specific docs. The sections are as follows: diff --git a/docs/src/dev-guide/tooling-containers.md b/docs/src/dev-docs/tooling-containers.md similarity index 100% rename from docs/src/dev-guide/tooling-containers.md rename to docs/src/dev-docs/tooling-containers.md diff --git a/docs/src/dev-guide/tooling-gh-workflows.md b/docs/src/dev-docs/tooling-gh-workflows.md similarity index 100% rename from docs/src/dev-guide/tooling-gh-workflows.md rename to docs/src/dev-docs/tooling-gh-workflows.md diff --git a/docs/src/index.md b/docs/src/index.md index e1f719d640..15be6ad875 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -71,21 +71,21 @@ features: # Getting started -Check out the relevant guide below, based on whether you'd like to use or develop CLP. +Check out the relevant docs below, based on whether you'd like to use or develop CLP. ::::{grid} 1 1 2 2 :gutter: 2 :::{grid-item-card} -:link: user-guide/index -User guide +:link: user-docs/index +User docs ^^^ Docs for those interested in using and operating CLP. ::: :::{grid-item-card} -:link: dev-guide/index -Developer guide +:link: dev-docs/index +Developer docs ^^^ Docs for those interested in developing CLP. ::: @@ -107,8 +107,8 @@ Need help? Join us on one of our community servers: :::{toctree} :hidden: -user-guide/index -dev-guide/index +user-docs/index +dev-docs/index ::: [badge-discord]: https://img.shields.io/discord/1377353873068392580?style=flat&logo=discord&logoColor=white&label=Discord&labelColor=%235561f5 @@ -118,7 +118,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-docs/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 diff --git a/docs/src/user-guide/core-clp-s.md b/docs/src/user-docs/core-clp-s.md similarity index 100% rename from docs/src/user-guide/core-clp-s.md rename to docs/src/user-docs/core-clp-s.md diff --git a/docs/src/user-guide/core-container.md b/docs/src/user-docs/core-container.md similarity index 100% rename from docs/src/user-guide/core-container.md rename to docs/src/user-docs/core-container.md diff --git a/docs/src/user-guide/core-overview.md b/docs/src/user-docs/core-overview.md similarity index 96% rename from docs/src/user-guide/core-overview.md rename to docs/src/user-docs/core-overview.md index c8cdd9a312..956ec5f952 100644 --- a/docs/src/user-guide/core-overview.md +++ b/docs/src/user-docs/core-overview.md @@ -3,7 +3,7 @@ CLP's core component contains the core code to compress, decompress, and search compressed logs. You can use it to try CLP on your logs before deploying a cluster. -There are currently two flavours of CLP, depending on the format of your logs. The guides below +There are currently two flavours of CLP, depending on the format of your logs. The docs below explain how to use each flavour. ::::{grid} 1 1 2 2 diff --git a/docs/src/user-guide/core-unstructured/clp.md b/docs/src/user-docs/core-unstructured/clp.md similarity index 100% rename from docs/src/user-guide/core-unstructured/clp.md rename to docs/src/user-docs/core-unstructured/clp.md diff --git a/docs/src/user-guide/core-unstructured/glt.md b/docs/src/user-docs/core-unstructured/glt.md similarity index 100% rename from docs/src/user-guide/core-unstructured/glt.md rename to docs/src/user-docs/core-unstructured/glt.md diff --git a/docs/src/user-guide/core-unstructured/index.md b/docs/src/user-docs/core-unstructured/index.md similarity index 100% rename from docs/src/user-guide/core-unstructured/index.md rename to docs/src/user-docs/core-unstructured/index.md diff --git a/docs/src/user-guide/core-unstructured/make-dictionaries-readable.md b/docs/src/user-docs/core-unstructured/make-dictionaries-readable.md similarity index 100% rename from docs/src/user-guide/core-unstructured/make-dictionaries-readable.md rename to docs/src/user-docs/core-unstructured/make-dictionaries-readable.md diff --git a/docs/src/user-guide/guides-multi-node.md b/docs/src/user-docs/guides-multi-node.md similarity index 100% rename from docs/src/user-guide/guides-multi-node.md rename to docs/src/user-docs/guides-multi-node.md diff --git a/docs/src/user-guide/guides-overview.md b/docs/src/user-docs/guides-overview.md similarity index 100% rename from docs/src/user-guide/guides-overview.md rename to docs/src/user-docs/guides-overview.md diff --git a/docs/src/user-guide/guides-retention.md b/docs/src/user-docs/guides-retention.md similarity index 100% rename from docs/src/user-guide/guides-retention.md rename to docs/src/user-docs/guides-retention.md diff --git a/docs/src/user-guide/guides-using-object-storage/clp-config.md b/docs/src/user-docs/guides-using-object-storage/clp-config.md similarity index 100% rename from docs/src/user-guide/guides-using-object-storage/clp-config.md rename to docs/src/user-docs/guides-using-object-storage/clp-config.md diff --git a/docs/src/user-guide/guides-using-object-storage/clp-usage.md b/docs/src/user-docs/guides-using-object-storage/clp-usage.md similarity index 100% rename from docs/src/user-guide/guides-using-object-storage/clp-usage.md rename to docs/src/user-docs/guides-using-object-storage/clp-usage.md diff --git a/docs/src/user-guide/guides-using-object-storage/index.md b/docs/src/user-docs/guides-using-object-storage/index.md similarity index 100% rename from docs/src/user-guide/guides-using-object-storage/index.md rename to docs/src/user-docs/guides-using-object-storage/index.md diff --git a/docs/src/user-guide/guides-using-object-storage/object-storage-config.md b/docs/src/user-docs/guides-using-object-storage/object-storage-config.md similarity index 100% rename from docs/src/user-guide/guides-using-object-storage/object-storage-config.md rename to docs/src/user-docs/guides-using-object-storage/object-storage-config.md diff --git a/docs/src/user-guide/guides-using-presto.md b/docs/src/user-docs/guides-using-presto.md similarity index 100% rename from docs/src/user-guide/guides-using-presto.md rename to docs/src/user-docs/guides-using-presto.md diff --git a/docs/src/user-guide/index.md b/docs/src/user-docs/index.md similarity index 92% rename from docs/src/user-guide/index.md rename to docs/src/user-docs/index.md index ad3cfa916e..724d4ee26f 100644 --- a/docs/src/user-guide/index.md +++ b/docs/src/user-docs/index.md @@ -1,6 +1,6 @@ -# User guide +# User docs -This guide documents how to use and operate CLP. Use the left sidebar (if it's hidden, click the +These docs explain how to use and operate CLP. Use the left sidebar (if it's hidden, click the icon) to navigate to specific docs. The sections are as follows: diff --git a/docs/src/user-guide/quick-start/clp-json-search-ui.png b/docs/src/user-docs/quick-start/clp-json-search-ui.png similarity index 100% rename from docs/src/user-guide/quick-start/clp-json-search-ui.png rename to docs/src/user-docs/quick-start/clp-json-search-ui.png diff --git a/docs/src/user-guide/quick-start/clp-json.md b/docs/src/user-docs/quick-start/clp-json.md similarity index 100% rename from docs/src/user-guide/quick-start/clp-json.md rename to docs/src/user-docs/quick-start/clp-json.md diff --git a/docs/src/user-guide/quick-start/clp-text-search-ui.png b/docs/src/user-docs/quick-start/clp-text-search-ui.png similarity index 100% rename from docs/src/user-guide/quick-start/clp-text-search-ui.png rename to docs/src/user-docs/quick-start/clp-text-search-ui.png diff --git a/docs/src/user-guide/quick-start/clp-text.md b/docs/src/user-docs/quick-start/clp-text.md similarity index 100% rename from docs/src/user-guide/quick-start/clp-text.md rename to docs/src/user-docs/quick-start/clp-text.md diff --git a/docs/src/user-guide/quick-start/index.md b/docs/src/user-docs/quick-start/index.md similarity index 100% rename from docs/src/user-guide/quick-start/index.md rename to docs/src/user-docs/quick-start/index.md diff --git a/docs/src/user-guide/reference-admin-tools.md b/docs/src/user-docs/reference-admin-tools.md similarity index 100% rename from docs/src/user-guide/reference-admin-tools.md rename to docs/src/user-docs/reference-admin-tools.md diff --git a/docs/src/user-guide/reference-json-search-syntax.md b/docs/src/user-docs/reference-json-search-syntax.md similarity index 100% rename from docs/src/user-guide/reference-json-search-syntax.md rename to docs/src/user-docs/reference-json-search-syntax.md diff --git a/docs/src/user-guide/reference-overview.md b/docs/src/user-docs/reference-overview.md similarity index 100% rename from docs/src/user-guide/reference-overview.md rename to docs/src/user-docs/reference-overview.md diff --git a/docs/src/user-guide/reference-text-search-syntax.md b/docs/src/user-docs/reference-text-search-syntax.md similarity index 100% rename from docs/src/user-guide/reference-text-search-syntax.md rename to docs/src/user-docs/reference-text-search-syntax.md diff --git a/docs/src/user-guide/reference-unstructured-schema-file.md b/docs/src/user-docs/reference-unstructured-schema-file.md similarity index 100% rename from docs/src/user-guide/reference-unstructured-schema-file.md rename to docs/src/user-docs/reference-unstructured-schema-file.md diff --git a/docs/src/user-guide/resources-datasets.md b/docs/src/user-docs/resources-datasets.md similarity index 100% rename from docs/src/user-guide/resources-datasets.md rename to docs/src/user-docs/resources-datasets.md