diff --git a/cratedb_toolkit/cfr/backlog.md b/doc/cfr/backlog.md similarity index 96% rename from cratedb_toolkit/cfr/backlog.md rename to doc/cfr/backlog.md index c71f517a..049a21c4 100644 --- a/cratedb_toolkit/cfr/backlog.md +++ b/doc/cfr/backlog.md @@ -1,4 +1,4 @@ -# CFR Backlog +# CrateDB CFR Backlog ## Iteration +1 - Software tests diff --git a/cratedb_toolkit/cfr/README.md b/doc/cfr/index.md similarity index 97% rename from cratedb_toolkit/cfr/README.md rename to doc/cfr/index.md index 6e7320ca..456ca7d3 100644 --- a/cratedb_toolkit/cfr/README.md +++ b/doc/cfr/index.md @@ -1,3 +1,4 @@ +(cfr)= # CrateDB Cluster Flight Recorder (CFR) CFR helps collecting information about CrateDB clusters for support requests @@ -25,7 +26,7 @@ ctk cfr sys-import file://./cfr/crate/2024-04-18T01-13-41/sys ``` -## Configuration +## Usage ### Target and source directories @@ -83,3 +84,11 @@ Import system table information. ```shell cfr sys-import cfr/crate/2024-04-18T01-13-41/sys ``` + + +```{toctree} +:maxdepth: 1 +:hidden: + +backlog +``` diff --git a/doc/index.md b/doc/index.md index cd8ad4f3..42e8a914 100644 --- a/doc/index.md +++ b/doc/index.md @@ -84,6 +84,8 @@ install datasets io/index retention +Cluster Flight Recorder (CFR) +Ad Hoc Diagnosis (WTF) ``` ```{toctree} diff --git a/cratedb_toolkit/wtf/backlog.md b/doc/wtf/backlog.md similarity index 98% rename from cratedb_toolkit/wtf/backlog.md rename to doc/wtf/backlog.md index 9f0c82e2..b4d01809 100644 --- a/cratedb_toolkit/wtf/backlog.md +++ b/doc/wtf/backlog.md @@ -1,4 +1,4 @@ -# cratedb-wtf backlog +# CrateDB WTF Backlog ## Iteration +1 - Display differences to the standard configuration diff --git a/cratedb_toolkit/wtf/README.md b/doc/wtf/index.md similarity index 93% rename from cratedb_toolkit/wtf/README.md rename to doc/wtf/index.md index 92ba946f..a20be212 100644 --- a/cratedb_toolkit/wtf/README.md +++ b/doc/wtf/index.md @@ -1,4 +1,5 @@ -# cratedb-wtf +(wtf)= +# CrateDB WTF A diagnostics utility in the spirit of [git-wtf], [grafana-wtf], and [pip.wtf]. It is still a work-in-progress, but it is usable already. @@ -50,6 +51,14 @@ http http://127.0.0.1:4242/info/all ``` +```{toctree} +:maxdepth: 1 +:hidden: + +backlog +``` + + [git-wtf]: http://thrawn01.org/posts/2014/03/03/git-wtf/ [grafana-wtf]: https://github.com/panodata/grafana-wtf