Skip to content

Commit aa76a59

Browse files
authored
Merge pull request #8020 from Particular/editorial
Weekly recent docs review editorial: 2025-12-22
2 parents 74b94b6 + bfa4257 commit aa76a59

File tree

7 files changed

+8
-16
lines changed

7 files changed

+8
-16
lines changed

nservicebus/outbox/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Outbox
3-
summary: Ensure message consistency with NServiceBus Outbox pattern preventing duplicate message processing in distributed systems.
3+
summary: Use the NServiceBus Outbox pattern to ensure message consistency and prevent duplicate message processing in distributed systems.
44
reviewed: 2025-06-05
55
component: Core
66
isLearningPath: true

persistence/sql/install.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ reviewed: 2025-12-19
99

1010
The SQL persistence package generates scripts to create necessary database assets. It is recommended to run those scripts as part of the deployment process. See [Installer Workflow](installer-workflow.md) for more information.
1111

12-
1312
## Script execution during development
1413

1514
To streamline development, SQL persistence will execute generated scripts at endpoint startup if installers are enabled.
@@ -19,18 +18,16 @@ snippet: ExecuteAtStartup
1918
> [!NOTE]
2019
> Automatically executing generated scripts is recommended only in development environments.
2120
22-
2321
## Script execution in non-development environments
2422

2523
In non-development environments, where the SQL persistence installation scripts have been executed as part of the deployment, it may be necessary to explicitly disable the SQL persistence installers if [standard installers](/nservicebus/operations/installers.md) need to be used for other purposes.
2624

2725
snippet: DisableInstaller
2826

29-
The `ScriptRunner` class can be used to run the scripts without creating and starting an NServiceBus endpoint
27+
The `ScriptRunner` class can be used to run the scripts without creating and starting an NServiceBus endpoint.
3028

3129
snippet: ScriptRunner
3230

33-
3431
## Table prefix
3532

3633
The *table prefix* is the string that is prefixed to every table name, e.g. Saga, Outbox, Subscription and Timeout tables.
@@ -46,7 +43,6 @@ When using the default approach to installation (execute at startup), the value
4643

4744
snippet: TablePrefix
4845

49-
5046
## Database schema
5147

5248
When using a database that supports schemas, a schema value other than default can be defined in the configuration API. Consult the documentation of the selected SQL dialect for details.
@@ -58,19 +54,16 @@ When using a database that supports schemas, a schema value other than default c
5854
> [!NOTE]
5955
> The same value must be passed to the installation scripts as a parameter.
6056
61-
6257
## Manual installation
6358

6459
When performing a custom script execution the table prefix is required. See also [Installer Workflow](installer-workflow.md).
6560

6661
Note that `scriptDirectory` can be either the root directory for all scripts or the specific locations for a given storage type i.e. Saga, Outbox, Subscription and Timeout scripts.
6762

68-
6963
### SQL Server
7064

7165
snippet: ExecuteScriptsSqlServer
7266

73-
7467
### MySQL
7568

7669
snippet: ExecuteScriptsMySql
@@ -79,7 +72,6 @@ snippet: ExecuteScriptsMySql
7972

8073
snippet: ExecuteScriptsOracle
8174

82-
8375
#### PostgreSQL
8476

8577
snippet: ExecuteScriptsPostgreSQL

platform/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Particular Service Platform consists of [NServiceBus](/nservicebus), [Servic
1515

1616
![Particular Service Platform architecture](architecture-overview.png)
1717

18-
The details of each component are discussed below. A Particular Service Platform-based system consists of several NServiceBus [endpoints](/nservicebus/endpoints/). Endpoints are logical entities that perform business operations. They communicate with each other using messages (via queues) and forward messages to ServiceControl for auditing. ServiceControl stores this audit trail and provides integration points for ServicePulse. ServicePulse provides monitoring and recoverability for production systems. ServicePulse provides debugging information and visualization of how the system works.
18+
The details of each component are discussed below. A Particular Service Platform-based system consists of several NServiceBus [endpoints](/nservicebus/endpoints/). Endpoints are logical entities that perform business operations. They communicate with each other using messages (via queues) and forward messages to ServiceControl for auditing. ServiceControl stores this audit trail and provides integration points for ServicePulse. ServicePulse provides monitoring and recoverability for production systems, as well as debugging information and visualization of how the system works.
1919

2020
## [NServiceBus](/nservicebus) - where it all begins
2121

platform/nservicebus.include.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ NServiceBus is designed to work with the rest of the Particular Service Platform
7676

7777
When a message fails to be processed, even after a number of retry strategies have been attempted, NServiceBus will forward the message to an [error queue](/nservicebus/recoverability/configure-error-handling.md) for manual investigation. Messages sent to the error queue are instrumented with headers containing details about the failure including a full exception stack trace. ServiceControl picks up messages from the error queue and makes them available in [ServicePulse](/servicepulse/). Once the root cause of the failure has been found and corrected, all messages caused by the same problem can be retried at once.
7878

79-
Additionally, each endpoint can send [heartbeat](/monitoring/heartbeats/), [health check](/monitoring/custom-checks/), and [performance metrics](/monitoring/metrics/) through the platform for visualization in ServicePulse, making it easy to see which endpoints are offline, which are ready to scale out, and which require manual intervention. Message visualizations available in [ServicePulse](/servicepulse/message-details.md#messages-with-audited-conversation-data) make it easy to understand message flows and timing of a running NServiceBus system.
79+
Additionally, each endpoint can send [heartbeat](/monitoring/heartbeats/), [health check](/monitoring/custom-checks/), and [performance metrics](/monitoring/metrics/) through the platform for visualization in ServicePulse, making it easy to see which endpoints are offline, which are ready to scale out, and which require manual intervention. Message visualizations available in [ServicePulse](/servicepulse/message-details.md#messages-with-audited-conversation-data) make it easy to understand message flows and timing of a running NServiceBus system.
8080

8181
The [real-time monitoring demo](https://particular.net/real-time-monitoring) provides the ability to experience the Service Platform in action. The [Platform Sample package](/platform/platform-sample-package.md) provides the ability to demonstrate the Service Platform from within any .NET Project, without the need to install anything.
8282

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
> [!WARNING]
2-
> **ServiceInsight has been sunset**
2+
> **ServiceInsight has been sunset and will receive no further updates.**
33
>
4-
> We recommend [moving to ServicePulse](/servicepulse/installation.md) for vizualization and debugging capabilities.
4+
> We recommend [moving to ServicePulse](/servicepulse/installation.md) for vizualization and debugging capabilities.

serviceinsight/support-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ related:
1818
>
1919
> The latest version of ServiceInsight is supported (including bug fixes) until migration instructions to ServicePulse are available.
2020
21-
The latest version can be found on the [downloads page](https://particular.net/downloads), however, it is recommended to install the latest version of [ServicePulse](/servicepulse/installation.md) for the latest features and full support.
21+
The latest version can be found on the [downloads page](https://particular.net/downloads); however, it is recommended to install the latest version of [ServicePulse](/servicepulse/installation.md) for the latest features and full support.
2222

2323
## ServiceControl compatibility
2424

tutorials/quickstart/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Quickstart: Sending and processing your first messages"
33
reviewed: 2025-06-15
4-
summary: "Part 1: Learn messaging basics with NServiceBus quickstart guide covering commands,events, and publish subscribe patterns"
4+
summary: "Part 1: Learn messaging basics with NServiceBus quickstart guide covering commands, events, and the publish-subscribe pattern"
55
extensions:
66
- !!tutorial
77
nextText: "Next: Recovering from failure"

0 commit comments

Comments
 (0)