migrate rest

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>

doc/source/_toc.yml

@@ -153,6 +153,21 @@ parts:
           - file: ray-core/examples/testing-tips
       - file: ray-core/configure
       - file: ray-observability/index
+        sections:
+          - file: ray-core/ray-dashboard
+            title: "Using the Ray Dashboard"
+          - file: ray-observability/ray-debugging
+            title: "Using the Ray Debugger"
+          - file: ray-observability/ray-logging
+            title: "Logging Ray apps"
+          - file: ray-observability/ray-metrics
+            title: "Exporting Ray metrics"
+          - file: ray-observability/ray-tracing
+            title: "Tracing Ray apps"
+          - file: ray-observability/debugging
+            title: "Debugging Ray apps"
+          - file: ray-observability/profiling
+            title: "Profiling Ray apps"
       - file: ray-contribute/whitepaper
 
 # TODO: Add examples section

doc/source/ray-observability/debugging.md

@@ -1,3 +1,5 @@
+(debugging-ray)=
+
 # Debugging Ray applications (for developers)
 
 This document details, for Ray developers, how to debug your Ray applications.

doc/source/ray-observability/index.md

@@ -0,0 +1,69 @@
+# Observability
+
+Ray has a suite of tools to help you with observability of your programs,
+like the Ray dashboard and debugger, the ability to export metrics, trace
+your code with OpenTelemetry, and much more.
+
+```{eval-rst}
+.. panels::
+    :container: container pb-4
+    :column: col-md-4 px-2 py-2
+    :img-top-cls: pt-5 w-50 d-block mx-auto
+
+    ---
+    :img-top: /images/ray_logo.png
+
+    .. link-button:: ray-dashboard
+        :type: ref
+        :text: How to use the Ray dashboard?
+        :classes: btn-link btn-block stretched-link
+
+    ---
+    :img-top: /images/ray_logo.png
+
+    .. link-button:: ray-debugger
+        :type: ref
+        :text: How to use the Ray debugger?
+        :classes: btn-link btn-block stretched-link
+
+    ---
+    :img-top: /images/ray_logo.png
+
+    .. link-button:: ray-logging
+        :type: ref
+        :text: Understand Ray's logging system and logging best practices
+        :classes: btn-link btn-block stretched-link
+
+    ---
+    :img-top: /images/ray_logo.png
+
+    .. link-button:: ray-metrics
+        :type: ref
+        :text: How to export Ray metrics?
+        :classes: btn-link btn-block stretched-link
+
+    ---
+    :img-top: /images/ray_logo.png
+
+    .. link-button:: ray-tracing
+        :type: ref
+        :text: How to trace Ray applications with OpenTelemetry?
+        :classes: btn-link btn-block stretched-link
+
+    ---
+    :img-top: /images/ray_logo.png
+
+    .. link-button:: debugging-ray
+        :type: ref
+        :text: How to debug your Ray applications as a developer?
+        :classes: btn-link btn-block stretched-link
+
+
+    ---
+    :img-top: /images/ray_logo.png
+
+    .. link-button:: ray-profiling
+        :type: ref
+        :text: How to analyze the performance of your Ray programs?
+        :classes: btn-link btn-block stretched-link
+```

doc/source/ray-observability/index.rst

@@ -1,14 +0,0 @@
-Observability
-=============
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Observability, Debugging, and Profiling
-
-    ../ray-core/ray-dashboard
-    ray-debugging
-    ray-logging
-    ray-metrics
-    ray-tracing
-    ../ray-contribute/debugging
-    ../ray-contribute/profiling

doc/source/ray-observability/profiling.md

@@ -1,3 +1,5 @@
+(ray-profiling)=
+
 # Profiling Ray applications (for developers)
 
 This document details, for Ray developers, how to analyze Ray performance.

doc/source/ray-observability/ray-debugging.md

@@ -1,3 +1,5 @@
+(ray-debugger)=
+
 # Ray Debugger
 
 Ray has a built-in debugger that allows you to debug your distributed applications.

doc/source/ray-observability/ray-logging.md

@@ -1,4 +1,4 @@
-(ray-logging)=
+(ray-logging-ref)=
 
 # Logging
 

doc/source/ray-observability/ray-metrics.md

@@ -1,8 +1,8 @@
-(ray-metrics)=
+(ray-metrics-ref)=
 
 # Exporting Metrics
 
-To help monitoring Ray applications, Ray
+To help monitor Ray applications, Ray
 
 - Collects Ray's pre-selected system level metrics.
 - Exposes metrics in a Prometheus format. We'll call the endpoint to access

doc/source/serve/monitoring.md

@@ -22,7 +22,7 @@ In this example pictured above, we have a single-node cluster with a deployment
 ## Logging
 
 :::{note}
-For an overview of logging in Ray, see [Ray Logging](ray-logging).
+For an overview of logging in Ray, see [Ray Logging](ray-logging-ref).
 :::
 
 Ray Serve uses Python's standard `logging` facility with the `"ray.serve"` named logger.
@@ -197,7 +197,7 @@ You should see something similar to the following:
 ## Metrics
 
 Ray Serve exposes important system metrics like the number of successful and
-errored requests through the [Ray metrics monitoring infrastructure](ray-metrics). By default,
+errored requests through the [Ray metrics monitoring infrastructure](ray-metrics-ref). By default,
 the metrics are exposed in Prometheus format on each node.
 
 The following metrics are exposed by Ray Serve:
@@ -263,4 +263,4 @@ Here's an example:
 ```
 
 See the
-[Ray Metrics documentation](ray-metrics) for more details, including instructions for scraping these metrics using Prometheus.
+[Ray Metrics documentation](ray-metrics-ref) for more details, including instructions for scraping these metrics using Prometheus.