replaced the obsolete studio/server/server-dashboard page with a mana…

…ge-server page
ravendb · Feb 7, 2025 · f583d54 · f583d54
1 parent b88112d
commit f583d54
Show file tree

Hide file tree

Showing 21 changed files with 192 additions and 67 deletions.
diff --git a/Documentation/4.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/4.0/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/4.1/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/4.1/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/4.2/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/4.2/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/5.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.0/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/5.1/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.1/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/5.2/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.2/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/5.3/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.3/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/5.4/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.4/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/6.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/6.0/Raven.Documentation.Pages/studio/server/.docs.json
@@ -3,7 +3,13 @@
         "Path": "server-dashboard.markdown",
         "Name": "Server Dashboard",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "LastSupportedVersion": "6.0",
+        "Mappings": [
+            {
+                "Version": 6.2,
+                "Key": "studio/server/manage-server"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/overview.markdown b/Documentation/6.2/Raven.Documentation.Pages/studio/overview.markdown
@@ -9,7 +9,7 @@
 
 * Use Studio to manage your RavenDB 
   [cluster](../studio/cluster/cluster-dashboard/cluster-dashboard-overview), 
-  [servers](../studio/server/server-overview), 
+  [servers](../studio/server/manage-server), 
   and [databases](../studio/database/databases-list-view). 
   You can observe, modify, and create [indexes](../studio/database/indexes/indexes-overview), 
   issue [queries](../studio/database/queries/query-view), 
@@ -22,10 +22,11 @@
   and much more.
 
 * In this page:  
-  * [Accessing Studio After Setup](../studio/overview#the-cluster-dashboard)  
-  * [Manage Your RavenDB Server](../studio/overview#manage-your-server)  
-  * [Manage Your Databases](../studio/overview#manage-your-databases)  
-  * [Header and Footer Areas](../studio/overview#header-and-footer-areas)  
+   * [Accessing Studio After Setup](../studio/overview#accessing-studio-after-setup)  
+   * [The Cluster Dashboard](../studio/overview#the-cluster-dashboard)  
+   * [Manage Your Server](../studio/overview#manage-your-server)  
+   * [Manage Your Databases](../studio/overview#manage-your-databases)  
+   * [Header and Footer Areas](../studio/overview#header-and-footer-areas)  
 {NOTE/}
 
 ---

diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/6.2/Raven.Documentation.Pages/studio/server/.docs.json
@@ -1,9 +1,46 @@
 [
     {
-        "Path": "server-dashboard.markdown",
-        "Name": "Server Dashboard",
+        "Path": "manage-server.markdown",
+        "Name": "Manage Server",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
-        "Mappings": []
+        "Mappings": [
+            {
+                "Version": 6.0,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 5.4,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 5.3,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 5.2,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 5.1,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 5.0,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 4.2,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 4.1,
+                "Key": "studio/server/server-dashboard"
+            },
+            {
+                "Version": 4.0,
+                "Key": "studio/server/server-dashboard"
+            }
+        ]
     },
     {
         "Path": "client-configuration.markdown",

diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.png
diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.snagx
diff --git a/...cumentation.Pages/studio/server/images/manage-server_click-to-manage-server.png b/...cumentation.Pages/studio/server/images/manage-server_click-to-manage-server.png
diff --git a/...Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.snagx b/...Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.snagx
diff --git a/...ntation/6.2/Raven.Documentation.Pages/studio/server/images/server-dashboard.png b/...ntation/6.2/Raven.Documentation.Pages/studio/server/images/server-dashboard.png
diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-dashboard.snag b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-dashboard.snag
diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/manage-server.markdown b/Documentation/6.2/Raven.Documentation.Pages/studio/server/manage-server.markdown
@@ -0,0 +1,75 @@
+# Studio: Manage Server
+---
+
+{NOTE: }
+
+* Use the **Manage Server** menu to access your server's configuration and debugging options.  
+
+* In this page:  
+   * [Manage Server menu](../../studio/server/manage-server#manage-server-menu)  
+       * [Configuration options](../../studio/server/manage-server#manage-server-configuration-options)  
+       * [Debug options](../../studio/server/manage-server#debug-debugging-and-statistics-options)  
+
+{NOTE/}
+
+---
+
+{PANEL: Manage Server menu}
+
+Open the **Manage Server** menu from Studio's main menu.  
+
+![Main menu: Click to manage server](images/manage-server_click-to-manage-server.png "Main menu: Click to manage server")
+
+---
+
+The menu is divided into two main sections, one to configure various server 
+options and the second to debug the server and view various statistics.  
+
+![Manage Server menu](images/manage-server.png "Manage Server menu")
+
+### 1. Manage Server: Configuration options
+
+* [Cluster](../../studio/cluster/cluster-view)  
+  View and modify your cluster topology.  
+* [Client Configuration](../../studio/server/client-configuration)  
+  Set a client configuration that applies to all the databases in the cluster.  
+* [Studio Configuration](../../studio/database/settings/studio-configuration#studio-configuration---server-wide)  
+  Set server-wide Studio-related options, applied to all the databases hosted by this server.  
+* [Server Settings](../../studio/server/server-settings)  
+  Display settings common to all the databases hosted by this server.  
+* [Admin JS Console](../../studio/server/debug/admin-js-console)  
+  Use this console to run JavaScript code, to execute advanced operations on the server.  
+* [Certificates](../../studio/server/certificates/server-management-certificates-view)  
+  Export, Import and Customization options for server and client certificates.  
+* **Server-Wide Tasks**  
+  Define server-wide 
+  [External Replication](../../studio/database/tasks/ongoing-tasks/external-replication-task) 
+  and [Periodic Backup](../../studio/database/tasks/backup-task) 
+  tasks that apply to all the databases hosted by this server.  
+* [Server-Wide Analyzers](../../studio/database/settings/custom-analyzers#server-wide-custom-analyzer-view)  
+  Add server-wide custom analyzers, to split index fields into tokens 
+  that can be used by indexes on all the databases hosted by this server.  
+* [Server-Wide Sorters](../../studio/database/settings/custom-sorters#server-wide-custom-sorter-view)  
+  Add server-wide custom sorters, to define how query results are ordered 
+  by queries made on all the databases hosted by this server.  
+
+### 2. Debug: Debugging and statistics options
+
+* [Admin Logs](../../studio/server/debug/admin-logs)  
+  View a live stream of RavenDB log data, and modify logging settings.  
+* **Traffic Watch**  
+  View the HTTP requests made to the server.  
+* **Gather Debug Info**  
+  Collect diagnostics data from selected or all databases on this 
+  server or the entire cluster, to help troubleshoot and resolve issues.
+* **Storage Report**  
+* **IO Stats**  
+  View, Export, and Import I/O statistics.  
+* **Stack Traces**  
+  Capture debugging stack traces for this server or the entire cluster.  
+* **Running Queries**  
+* **Advanced**  
+  Advanced debug options, including the 
+  [Cluster Observer](../../studio/server/debug/advanced/cluster-observer).  
+
+{PANEL/}
diff --git a/...mentation/6.2/Raven.Documentation.Pages/studio/server/server-dashboard.markdown b/...mentation/6.2/Raven.Documentation.Pages/studio/server/server-dashboard.markdown
diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/overview.markdown b/Documentation/7.0/Raven.Documentation.Pages/studio/overview.markdown
@@ -9,7 +9,7 @@
 
 * Use Studio to manage your RavenDB 
   [cluster](../studio/cluster/cluster-dashboard/cluster-dashboard-overview), 
-  [servers](../studio/server/server-overview), 
+  [servers](../studio/server/manage-server), 
   and [databases](../studio/database/databases-list-view). 
   You can observe, modify, and create [indexes](../studio/database/indexes/indexes-overview), 
   issue [queries](../studio/database/queries/query-view), 
@@ -22,10 +22,11 @@
   and much more.
 
 * In this page:  
-  * [Accessing Studio After Setup](../studio/overview#the-cluster-dashboard)  
-  * [Manage Your RavenDB Server](../studio/overview#manage-your-server)  
-  * [Manage Your Databases](../studio/overview#manage-your-databases)  
-  * [Header and Footer Areas](../studio/overview#header-and-footer-areas)  
+   * [Accessing Studio After Setup](../studio/overview#accessing-studio-after-setup)  
+   * [The Cluster Dashboard](../studio/overview#the-cluster-dashboard)  
+   * [Manage Your Server](../studio/overview#manage-your-server)  
+   * [Manage Your Databases](../studio/overview#manage-your-databases)  
+   * [Header and Footer Areas](../studio/overview#header-and-footer-areas)  
 {NOTE/}
 
 ---

diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/7.0/Raven.Documentation.Pages/studio/server/.docs.json
@@ -1,7 +1,7 @@
 [
     {
-        "Path": "server-dashboard.markdown",
-        "Name": "Server Dashboard",
+        "Path": "manage-server.markdown",
+        "Name": "Manage Server",
         "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
         "Mappings": []
     },