Docs review (#6801)

* docs review * fix formatting * Update servicepulse/intro-pending-retries.md Co-authored-by: Jo Palac <[email protected]> --------- Co-authored-by: John Simons <[email protected]>
Particular · Aug 15, 2024 · ee0290c · ee0290c
1 parent e366a6e
commit ee0290c
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 14 deletions.
diff --git a/components/components.yaml b/components/components.yaml
@@ -701,7 +701,7 @@
 
 - Key: Migrations
   Name: Particular.TimeoutMigration
-  DocsUrl: nservicebus/tools
+  DocsUrl: nservicebus/tools/migrate-to-native-delivery
   GitHubOwner: Particular
   Category: Persistence
   SupportLevel: Tool
@@ -808,4 +808,4 @@
   LicenseUrl: https://github.com/Particular/NServiceBus.Persistence.DynamoDB/main/LICENSE.md
   ProjectUrl: https://github.com/Particular/NServiceBus.Persistence.DynamoDB
   NugetOrder:
-    - NServiceBus.Persistence.DynamoDB.TransactionalSession
+    - NServiceBus.Persistence.DynamoDB.TransactionalSession
diff --git a/menu/menu.yaml b/menu/menu.yaml
@@ -770,6 +770,8 @@
       Title: Software supply chain
   - Title: Tools
     Articles:
+    - Url: nservicebus/tools
+      Title: Overview
     - Url: nservicebus/tools/migrate-to-native-delivery
       Title: Migrating timeouts
     - Url: nservicebus/usage

diff --git a/nservicebus/messaging/immutable-messages.md b/nservicebus/messaging/immutable-messages.md
@@ -1,6 +1,6 @@
 ---
 title: Immutable Messages
-reviewed: 2021-09-08
+reviewed: 2024-08-13
 component: Core
 related:
 - samples/immutable-messages
@@ -16,11 +16,10 @@ Message objects can be made immutable at runtime by:
 1. Creating properties with only public getters and initializing these properties via constructor initialization.
 2. Having regular message classes with public getters/setters at the sender, where these classes implement an interface with only public getters. Receivers reference only the interface.
 
-
 ## Properties with only public getters
 
 > [!NOTE]
-> [Not all serializers support deserialization to private setters](/nservicebus/serialization/).
+> Not all serializers [support deserialization to private setters](/nservicebus/serialization/#immutable-message-types).
 
 ```c#
 public class CancelOrder : ICommand

diff --git a/nservicebus/tools/index.md b/nservicebus/tools/index.md
@@ -1,10 +1,13 @@
 ---
 title: Tools
 summary: An overview of tools related to NServiceBus
-reviewed: 2021-09-14
+reviewed: 2024-08-13
+related:
+  - nservicebus/usage
 ---
 
 - [Particular.TimeoutMigration](migrate-to-native-delivery.md)
+- [Particular.EndpointThroughputCounter](/nservicebus/throughput-tool)
 
 ## Support policy
 

diff --git a/samples/immutable-messages/sample.md b/samples/immutable-messages/sample.md
@@ -1,7 +1,7 @@
 ---
 title: Immutable Messages samples
 summary: Demonstrate how to use immutable messages when exchanging messages between endpoints.
-reviewed: 2021-09-21
+reviewed: 2024-08-13
 component: Core
 related:
 - nservicebus/messaging/immutable-messages

diff --git a/servicepulse/intro-pending-retries.md b/servicepulse/intro-pending-retries.md
@@ -1,7 +1,7 @@
 ---
 title: Pending Retries Message Management
 summary: Describes how ServicePulse detects and monitors failed messages in the pending state, and allows retrying, or deleting them.
-reviewed: 2021-09-08
+reviewed: 2024-08-13
 ---
 
 In ServicePulse versions 1.6.6 and above, there is a screen to view and manage failed messages that have been requested to be retried but have not completed yet.
@@ -42,9 +42,9 @@ The Pending Retries screen shows failed messages for which a retry was requested
 
 Failed messages that are retried may stay in the pending state for the following reasons:
 
- * The retrying endpoint is not working (e.g. crashed or is scaled-out) and the retried messages are waiting in the queue and have not yet been processed.
- * The retry operation failed and the message is in ServiceControl's Dead Letter Queue.
- * The retrying endpoint does not have auditing enabled but has successfully processed the retried message(s).
+- The retrying endpoint is not working (e.g. crashed or is scaled-out) and the retried messages are waiting in the queue and have not yet been processed.
+- The retry operation failed and the message is in ServiceControl's Dead Letter Queue.
+- The retrying endpoint does not have auditing enabled but has successfully processed the retried message(s).
 
 The messages displayed on this screen can be filtered based on the time period by selecting one of the options, such as messages in the last two hours, or messages in the previous day or week. The default option is set to display all pending messages.
 
@@ -54,9 +54,7 @@ Results can be filtered by queue name using the search functionality:
 
 ![Queue Filter](images/pending-retries-filter-queues.png 'width=500')
 
-Detailed information about the message, such as failure timestamp, endpoint, stack trace of the error, etc., is displayed in the same manner as on the [Failed Messages](intro-failed-messages.md) page providing additional information as follows:
-
- * **Redirect** Information if a redirect is created for this queue.
+Detailed information about the message, such as the failure timestamp, endpoint, stack trace of the error, etc., is displayed in the same manner as on the [Failed Messages](intro-failed-messages.md) page, additionally providing information about [redirects](/servicepulse/redirect.md) if one is created for this queue.
 
 ### Retrying a message