Documentation: Slot in docs about CFR and WTF

crate · May 8, 2024 · 0b3a47c · 0b3a47c
1 parent f1d1f07
commit 0b3a47c
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 4 deletions.
diff --git a/cratedb_toolkit/cfr/backlog.md → doc/cfr/backlog.md b/cratedb_toolkit/cfr/backlog.md → 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 → doc/cfr/index.md b/cratedb_toolkit/cfr/README.md → 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
@@ -84,6 +84,8 @@ install
 datasets
 io/index
 retention
+Cluster Flight Recorder (CFR) <cfr/index>
+Ad Hoc Diagnosis (WTF) <wtf/index>
 ```
 
 ```{toctree}

diff --git a/cratedb_toolkit/wtf/backlog.md → doc/wtf/backlog.md b/cratedb_toolkit/wtf/backlog.md → 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 → doc/wtf/index.md b/cratedb_toolkit/wtf/README.md → 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