Start surfacing docs in rustdoc

deployment-examples/kubernetes/BUILD.bazel

@@ -0,0 +1,12 @@
+filegroup(
+    name = "kubernetes",
+    srcs = [
+        "README.md",
+        "cas.json",
+        "cas.yaml",
+        "scheduler.json",
+        "scheduler.yaml",
+        "worker.json",
+    ],
+    visibility = ["//visibility:public"],
+)

flake.nix

@@ -91,7 +91,7 @@
         src = pkgs.lib.cleanSourceWith {
           src = craneLib.path ./.;
           filter = path: type:
-            (builtins.match "^.+/data/SekienAkashita\\.jpg" path != null)
+            (builtins.match "^.+/(data/SekienAkashita\\.jpg|deployment-examples/kubernetes/(README\\.md|cas\\.json|cas\\.yaml|scheduler\\.json|scheduler\\.yaml|worker\\.json)|README\\.md|examples/README\\.md)" path != null)
             || (craneLib.filterCargoSources path type);
         };
 

nativelink-config/BUILD.bazel

@@ -14,6 +14,11 @@ rust_library(
         "src/serde_utils.rs",
         "src/stores.rs",
     ],
+    compile_data = [
+        "README.md",
+        "examples/README.md",
+        "//deployment-examples/kubernetes",
+    ],
     visibility = ["//visibility:public"],
     deps = [
         "@crates//:serde",

nativelink-config/Cargo.toml

@@ -6,3 +6,6 @@ edition = "2021"
 [dependencies]
 serde = { version = "1.0.197", features = ["derive"] }
 shellexpand = "3.1.0"
+
+[package.metadata.docs.rs]
+readme = "./README.md"

nativelink-config/src/lib.rs

@@ -12,6 +12,75 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#![doc = include_str!("../README.md")]
+#![doc = "\n\n"] // Add some spacing between the two README files
+#![doc = "
+<details>
+  <summary>Example Configuration Breakdown</summary>
+"]
+#![doc = include_str!("../examples/README.md")]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>Example Kubernetes Configuraton Breakdown</summary>
+"]
+#![doc = "
+<details>
+  <summary>CAS JSON Config</summary>
+"]
+#![doc = "\n"]
+#![doc = "```json"]
+#![doc = include_str!("../../deployment-examples/kubernetes/cas.json")]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>Scheduler JSON Config</summary>
+"]
+#![doc = "\n"]
+#![doc = "```json"]
+#![doc = include_str!("../../deployment-examples/kubernetes/scheduler.json")]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>Scheduler YAML</summary>
+"]
+#![doc = "\n"]
+#![doc = "```yaml"]
+#![doc = "# Test"]
+#![doc = include_str!("../../deployment-examples/kubernetes/scheduler.yaml")]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>Worker JSON</summary>
+"]
+#![doc = "\n"]
+#![doc = "```yaml"]
+#![doc = "# Test"]
+#![doc = include_str!("../../deployment-examples/kubernetes/worker.json")]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>CAS YAML</summary>
+"]
+#![doc = "\n"]
+#![doc = "```yaml"]
+#![doc = include_str!("../../deployment-examples/kubernetes/cas.yaml")]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = include_str!("../../deployment-examples/kubernetes/README.md")]
+#![doc = "</details>"]
+#![doc = "\n\n"] // Add some spacing between the two README files
+#![doc = "</details>"]
+
 pub mod cas_server;
 pub mod schedulers;
 mod serde_utils;