docs: add build and test docs for all mayastor repos

Signed-off-by: Tiago Castro <[email protected]>

doc/build-all.md

@@ -13,12 +13,12 @@ you won't need to worry about cross compiler toolchains, and all builds are repr
 ## Table of Contents
 
 - [Prerequisites](#prerequisites)
-    - [Build system](#build-system)
-    - [Source Code](#source-code)
+  - [Build system](#build-system)
+  - [Source Code](#source-code)
 - [Building and Pushing](#building-and-pushing)
-    - [Building](#building)
-    - [Pushing](#pushing)
-    - [Installing](#installing)
+  - [Building](#building)
+  - [Pushing](#pushing)
+  - [Installing](#installing)
 
 ## Prerequisites
 
@@ -53,27 +53,27 @@ Mayastor is split across different GitHub repositories under the [OpenEBS][githu
 Here's a breakdown of the required repos for the task at hand:
 
 - **_data-plane_**: <https://github.com/openebs/mayastor>
-    - The data-plane components:
-        - io-engine (the only one which we need for this)
-        - io-engine-client
-        - casperf
+  - The data-plane components:
+    - io-engine (the only one which we need for this)
+    - io-engine-client
+    - casperf
 - **_control-plane_**: <https://github.com/openebs/mayastor-control-plane>
-    - Various control-plane components:
-        - agent-core
-        - agent-ha-cluster
-        - agent-ha-node
-        - operator-diskpool
-        - csi-controller
-        - csi-node
-        - api-rest
+  - Various control-plane components:
+    - agent-core
+    - agent-ha-cluster
+    - agent-ha-node
+    - operator-diskpool
+    - csi-controller
+    - csi-node
+    - api-rest
 - **_extensions_**: <https://github.com/openebs/mayastor-extensions>
-    - Mostly K8s specific components:
-        - kubectl-mayastor
-        - metrics-exporter-io-engine
-        - call-home
-        - stats-aggregator
-        - upgrade-job
-    - Also contains the helm-chart
+  - Mostly K8s specific components:
+    - kubectl-mayastor
+    - metrics-exporter-io-engine
+    - call-home
+    - stats-aggregator
+    - upgrade-job
+  - Also contains the helm-chart
 
 > **_NOTE_**:
 > There are also a few other repositories which are pulled or submoduled by the repositories above

doc/build.md

@@ -217,8 +217,6 @@ you want to run them locally:
 
 [nix-install]: https://nixos.org/download.html
 
-[nix-develop]: https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-develop.html
-
 [nix-paper]: https://edolstra.github.io/pubs/nixos-jfp-final.pdf
 
 [nix-build]: https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-build.html
@@ -227,8 +225,6 @@ you want to run them locally:
 
 [nix-shell]: https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-shell.html
 
-[nix-channel]: https://nixos.wiki/wiki/Nix_channels
-
 [nixos]: https://nixos.org/
 
 [rust-lang]: https://www.rust-lang.org/
@@ -242,5 +238,3 @@ you want to run them locally:
 [reproducible-builds]: https://reproducible-builds.org/
 
 [cii-best-practices]: https://www.coreinfrastructure.org/programs/best-practices-program/
-
-[direnv]: https://direnv.net/