From 9fd904753055568d70c17d63fd640a365e7cb730 Mon Sep 17 00:00:00 2001 From: Andre Klapper Date: Sun, 17 Aug 2025 12:38:02 +0200 Subject: [PATCH] Diviner: Fix Config related navigation instructions Summary: Numerous Config panels got moved into subsections in rPcb481f36 and rPa72ade94. Adjust the documentation accordingly. Test Plan: * Try to follow these docs, go to http://phorge.localhost/config/, be less confused. * Optionally, run `./bin/diviner generate` and browse the corrected pages under http://phorge.localhost/diviner Reviewers: O1 Blessed Committers, valerio.bozzolan Reviewed By: O1 Blessed Committers, valerio.bozzolan Subscribers: tobiaswiese, valerio.bozzolan, Matthew, Cigaryno Differential Revision: https://we.phorge.it/D26266 --- src/docs/user/cluster/cluster_databases.diviner | 6 +++--- src/docs/user/cluster/cluster_repositories.diviner | 4 ++-- src/docs/user/cluster/cluster_search.diviner | 4 ++-- src/docs/user/configuration/managing_garbage.diviner | 8 ++++---- src/docs/user/configuration/storage_adjust.diviner | 8 ++++---- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/docs/user/cluster/cluster_databases.diviner b/src/docs/user/cluster/cluster_databases.diviner index 51d8c642e3..a175c6e209 100644 --- a/src/docs/user/cluster/cluster_databases.diviner +++ b/src/docs/user/cluster/cluster_databases.diviner @@ -120,9 +120,9 @@ effect, then continue to "Monitoring Replicas" to verify the configuration. Monitoring Replicas =================== -You can monitor replicas in {nav Config > Database Servers}. This interface -shows you a quick overview of replicas and their health, and can detect some -common issues with replication. +You can monitor replicas in {nav Config > Services > Database Servers}. This +interface shows you a quick overview of replicas and their health, and can +detect some common issues with replication. The table on this page shows each database and current status. diff --git a/src/docs/user/cluster/cluster_repositories.diviner b/src/docs/user/cluster/cluster_repositories.diviner index 2160a73fef..89c519f63d 100644 --- a/src/docs/user/cluster/cluster_repositories.diviner +++ b/src/docs/user/cluster/cluster_repositories.diviner @@ -265,8 +265,8 @@ Monitoring Services =================== You can get an overview of repository cluster status from the -{nav Config > Repository Servers} screen. This table shows a high-level -overview of all active repository services. +{nav Config > Services > Repository Servers} screen. This table shows a +high-level overview of all active repository services. **Repos**: The number of repositories hosted on this service. diff --git a/src/docs/user/cluster/cluster_search.diviner b/src/docs/user/cluster/cluster_search.diviner index 4bbd1c2fbd..31c82455a9 100644 --- a/src/docs/user/cluster/cluster_search.diviner +++ b/src/docs/user/cluster/cluster_search.diviner @@ -127,8 +127,8 @@ A typical `elasticsearch` service configuration looks like this: Monitoring Search Services ========================== -You can monitor fulltext search in {nav Config > Search Servers}. This -interface shows you a quick overview of services and their health. +You can monitor fulltext search in {nav Config > Services > Search Servers}. +This interface shows you a quick overview of services and their health. The table on this page shows some basic stats for each configured service, followed by the configuration and current status of each host. diff --git a/src/docs/user/configuration/managing_garbage.diviner b/src/docs/user/configuration/managing_garbage.diviner index 5c5ef87762..d2ec532c46 100644 --- a/src/docs/user/configuration/managing_garbage.diviner +++ b/src/docs/user/configuration/managing_garbage.diviner @@ -12,8 +12,8 @@ passed, so they are deleted automatically (often after a month or two) in a process called "garbage collection". Garbage collection is performed automatically by the daemons. You can review -all of the installed garbage collectors by browsing to {nav Config > Garbage -Collectors}. +all of the installed garbage collectors by browsing to {nav Config > +Extensions/Modules > Garbage Collectors}. Configuring Retention Policies @@ -31,8 +31,8 @@ some logs for a longer period of time, perhaps for auditing or analytic purposes. You can review the current retention policies in -{nav Config > Garbage Collectors}. To change a policy, use -`bin/garbage set-policy` to select a new policy: +{nav Config > Extensions/Modules > Garbage Collectors}. To change a policy, +use `bin/garbage set-policy` to select a new policy: ``` phorge/ $ ./bin/garbage set-policy --collector cache.markup --days 7 diff --git a/src/docs/user/configuration/storage_adjust.diviner b/src/docs/user/configuration/storage_adjust.diviner index e460ddd041..d01f62d2e8 100644 --- a/src/docs/user/configuration/storage_adjust.diviner +++ b/src/docs/user/configuration/storage_adjust.diviner @@ -51,10 +51,10 @@ Reviewing Outstanding Adjustments There are two ways to review outstanding adjustments: you can use the web UI, or you can use the CLI. -To access the web UI, navigate to {nav Config > Database Status} or -{nav Config > Database Issues}. The //Database Status// panel provides a general -overview of all schemata. The //Database Issues// panel shows outstanding -issues. +To access the web UI, navigate to {nav Config > Services > Database Status} or +{nav Config > Services > Schemata Issues}. The //Database Status// panel +provides a general overview of all schemata. The //Schemata Issues// panel +shows outstanding issues. These interfaces report //Errors//, which are serious issues that can not be resolved through adjustment, and //Warnings//, which are minor issues that the -- 2.51.2