Updates to documentation (#7574)

jpalac · web-flow · commit cbca219da7ac · 2025-08-01T09:14:17.000+10:00
* ninject wording updates

* update links in ninject

* EF core wording changes

* mysql scripts review and lint fixes
diff --git a/nservicebus/dependency-injection/ninject.md b/nservicebus/dependency-injection/ninject.md
@@ -1,7 +1,7 @@
 ---
 title: Ninject
 summary: Configure NServiceBus to use Ninject for dependency injection.
-reviewed: 2023-09-15
+reviewed: 2025-07-31
 component: Ninject
 related:
  - samples/dependency-injection/ninject
@@ -14,31 +14,28 @@ include: container-deprecation-notice
 
 NServiceBus can be configured to use [Ninject](http://www.ninject.org/) for dependency injection.
 
-
 ### Default usage
 
 snippet: Ninject
 
-
 ### Using an existing kernel
 
 snippet: Ninject_Existing
 
-
 ### Unit of work
 
-Its is possible to bind to use an _Unit of Work_ scope, which corresponds to the `DependencyLifecycle.InstancePerUnitOfWork` lifecycle, when registering components with `configuration.RegisterComponents(...)`.
+It is possible to bind to use an _Unit of Work_ scope, which corresponds to the `DependencyLifecycle.InstancePerUnitOfWork` lifecycle, when registering components with `configuration.RegisterComponents(...)`.
 
 In essence, bindings using _Unit of Work_ scope
 
- * will be instantiated only once per transport Message
- * will be disposed when message processing finishes
+- will be instantiated only once per transport Message
+- will be disposed when message processing finishes
 
 Bind the services in _Unit of Work_ scope using:
 
 snippet: NinjectUnitOfWork
 
-Services using `InUnitOfWorkScope()` can only be injected into code which is processing messages. To inject the service somewhere else (e.g. because of an user interaction) define conditional bindings:
+Services using `InUnitOfWorkScope()` can only be injected into code which is processing messages. To inject the service somewhere else (e.g. because of a user interaction) define conditional bindings:
 
 snippet: NinjectConditionalBindings
 
@@ -48,18 +45,16 @@ snippet: NinjectContextPreservationFuncBinding
 
 ### Multi hosting
 
-Multiple endpoints in a single process cannot share a single Ninject kernel. Each requires its own container instance or each requires its own child container. Ninject supports this with the [Ninject.Extensions.ChildKernel](https://github.com/ninject/Ninject.Extensions.ChildKernel) extension. Execute `new ChildKernel(parentKernel)` and pass this new kernel instance to NServiceBus.
-
+Multiple endpoints in a single process cannot share a single Ninject kernel. Each one requires its own container instance or its own child container. Ninject supports this with the [Ninject.Extensions.ChildKernel](https://github.com/ninject/Ninject.Extensions.ChildKernel) extension. Execute `new ChildKernel(parentKernel)` and pass this new kernel instance to NServiceBus.
 
 ### DependencyLifecycle Mapping
 
 [`DependencyLifecycle`](/nservicebus/dependency-injection/) maps to [Ninject object scopes](https://github.com/ninject/ninject/wiki/Object-Scopes) as follows:
 
 | `DependencyLifecycle`                                                                                             | Ninject object scope                                                                                                        |
 |-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
-| [InstancePerCall](/nservicebus/dependency-injection/) | [Transient](https://github.com/ninject/ninject/wiki/Object-Scopes)         |
-| [InstancePerUnitOfWork](/nservicebus/dependency-injection/)                    | [Singleton](https://github.com/ninject/ninject/wiki/Object-Scopes) within a [Named Scope](https://github.com/ninject/ninject.extensions.namedscope/wiki) per Unit of Work |
-| [SingleInstance](/nservicebus/dependency-injection/)                                  | [Singleton](https://github.com/ninject/ninject/wiki/Object-Scopes)                          |
-
+| [InstancePerCall](/nservicebus/dependency-injection/#service-registrations-instance-per-call) | [Transient](https://github.com/ninject/ninject/wiki/Object-Scopes)         |
+| [InstancePerUnitOfWork](/nservicebus/dependency-injection/#service-registrations-instance-per-unit-of-work)                    | [Singleton](https://github.com/ninject/ninject/wiki/Object-Scopes) within a [Named Scope](https://github.com/ninject/ninject.extensions.namedscope/wiki) per Unit of Work |
+| [SingleInstance](/nservicebus/dependency-injection/#service-registrations-single-instance)                                  | [Singleton](https://github.com/ninject/ninject/wiki/Object-Scopes)                          |
 
-include: property-injection
+include: property-injection
diff --git a/persistence/sql/mysql-scripts.md b/persistence/sql/mysql-scripts.md
@@ -1,194 +1,160 @@
 ---
 title: MySql Scripts
 component: SqlPersistence
-reviewed: 2023-09-14
+reviewed: 2025-07-31
 related:
  - nservicebus/operations
  - persistence/sql/operational-scripting
 redirects:
  - nservicebus/sql-persistence/mysql-scripts
 ---
 
-
 Scripts and SQL used when interacting with a [MySql](https://www.mysql.com/) database.
 
-
 ## Build Time
 
 Scripts are created at build time and are executed as part of a deployment or decommissioning of an endpoint.
- 
 
 ### Outbox
 
-
 #### Create Table
 
 snippet: MySql_OutboxCreateSql
 
-
 #### Drop Table
 
 snippet: MySql_OutboxDropSql
 
-
 ### Saga
 
-For a Saga with the following structure 
+For a Saga with the following structure
 
 snippet: CreationScriptSaga
 
-
 #### Create Table
 
 snippet: MySql_SagaCreateSql
 
-
 #### Drop Table
 
 snippet: MySql_SagaDropSql
 
-
 ### Subscription
 
-
 #### Create Table
 
 snippet: MySql_SubscriptionCreateSql
 
-
 #### Drop Table
 
 snippet: MySql_SubscriptionDropSql
 
-
 ### Timeout
 
-
 #### Create Table
 
 snippet: MySql_TimeoutCreateSql
 
-
 #### Drop Table
 
 snippet: MySql_TimeoutDropSql
 
-
 ## Run Time
 
 SQL used at runtime to query and update data.
 
-
 ### Outbox
 
 Used at intervals to cleanup old outbox records.
 
 snippet: MySql_OutboxCleanupSql
 
-
 #### Get
 
 Used by `IOutboxStorage.SetAsDispatched`.
 
 snippet: MySql_OutboxGetSql
 
-
 #### SetAsDispatched
 
 Used by `IOutboxStorage.SetAsDispatched`.
 
 snippet: MySql_OutboxSetAsDispatchedSql
 
-
 #### Store
 
 Used by `IOutboxStorage.Store`.
 
 partial: outbox
 
-
 ### Saga
 
-
 #### Complete
 
 Used by `ISagaPersister.Complete`.
 
 snippet: MySql_SagaCompleteSql
 
-
 #### Save
 
 Used by `ISagaPersister.Save`.
 
 snippet: MySql_SagaSaveSql
 
-
 #### GetByProperty
 
 Used by `ISagaPersister.Get(propertyName...)`.
 
 snippet: MySql_SagaGetByPropertySql
 
-
 #### GetBySagaId
 
 Used by `ISagaPersister.Get(sagaId...)`.
 
 snippet: MySql_SagaGetBySagaIdSql
 
-
 #### Update
 
 Used by `ISagaPersister.Update`.
 
 snippet: MySql_SagaUpdateSql
 
-
 partial: finder
 
-
 ### Subscription
 
-
 #### GetSubscribers
 
 Used by `ISubscriptionStorage.GetSubscriberAddressesForMessage`.
 
 snippet: MySql_SubscriptionGetSubscribersSql
 
-
 #### Subscribe
 
 Used by `ISubscriptionStorage.Subscribe`.
 
 snippet: MySql_SubscriptionSubscribeSql
 
-
 #### Unsubscribe
 
 Used by `ISubscriptionStorage.Unsubscribe`.
 
 snippet: MySql_SubscriptionUnsubscribeSql
 
-
 ### Timeout
 
-
 #### Peek
 
 Used by `IPersistTimeouts.Peek`.
 
 snippet: MySql_TimeoutPeekSql
 
-
 #### Add
 
 Used by `IPersistTimeouts.Add`.
 
 snippet: MySql_TimeoutAddSql
 
-
 #### GetNextChunk
 
 Used by `IQueryTimeouts.GetNextChunk`.
@@ -197,14 +163,12 @@ snippet: MySql_TimeoutNextSql
 
 snippet: MySql_TimeoutRangeSql
 
-
 #### TryRemove
 
 Used by `IPersistTimeouts.TryRemove`.
 
 snippet: MySql_TimeoutRemoveByIdSql
 
-
 #### RemoveTimeoutBy
 
 Used by `IPersistTimeouts.RemoveTimeoutBy`.
diff --git a/persistence/sql/mysql-scripts_finder_sqlpersistence_[2,).partial.md b/persistence/sql/mysql-scripts_finder_sqlpersistence_[2,).partial.md
@@ -1,4 +1,4 @@
 
 #### Select used by Saga Finder
 
-snippet: MySql_SagaSelectSql
+snippet: MySql_SagaSelectSql
diff --git a/persistence/sql/mysql-scripts_outbox_sqlpersistence_[6,).partial.md b/persistence/sql/mysql-scripts_outbox_sqlpersistence_[6,).partial.md
@@ -2,9 +2,8 @@
 
 snippet: MySql_OutboxOptimisticStoreSql
 
-
 ##### Pessimistic mode
 
 snippet: MySql_OutboxPessimisticBeginSql
 
-snippet: MySql_OutboxPessimisticCompleteSql
+snippet: MySql_OutboxPessimisticCompleteSql
diff --git a/samples/entity-framework-core/sample.md b/samples/entity-framework-core/sample.md
@@ -1,66 +1,61 @@
 ---
 title: Entity Framework Core integration with SQL Persistence
 summary: Integrating Entity Framework Core with SQL Persistence.
-reviewed: 2023-08-11
+reviewed: 2025-07-31
 component: SqlPersistence
 related:
 - persistence/sql
 ---
 
-
 ## Prerequisites
 
 include: sql-prereq
 
 The database created by this sample is `NsbSamplesEfCoreUowSql`.
 
-
 ## Running the project
 
  1. Start the solution
- 2. The text `Press <enter> to send a message` will appear in both console windows
- 3. Press <kbd>enter</kbd> in both console windows
+ 2. The text `Press <enter> to send a message` will appear in the console window
+ 3. Press <kbd>enter</kbd> to send an order
 
 > [!NOTE]
 > If exceptions occur when running the sample, delete the tables from the database used by the code. By default, Entity Framework will not update table schemas. If tables use an old schema, the code won't execute properly.
 
-
 ## Verifying that the sample works
 
  1. `CreateOrderHandler` displays information that an order was submitted.
  2. `OrderLifecycleSaga` displays information that the order process has been started.
  3. `CreateShipmentHandler` displays information that the shipment has been created.
  4. After a few seconds, `CompleteOrderHandler` displays information that the order is going to be completed.
 
-Open SQL Server Management Studio and go to the database. Verify that there is a row in the saga state table (`dbo.OrderLifecycleSagaData`), in the orders table (`dbo.Orders`), and in the shipments table (`dbo.Shipments`).
-
+Open SQL Server Management Studio and go to the database. Verify that there is a row in the saga state table (`dbo.Samples.EntityFrameworkUnitOfWork.SQL.OrderLifecycleSagaData`), in the orders table (`dbo.Orders`), and in the shipments table (`dbo.Shipments`).
 
 ## Code walk-through
 
 This sample contains the following projects:
 
- * **Messages**: A class library containing the message definitions.
- * **Endpoint.SqlPersistence**: A console application running the endpoint with SQL persistence.
-
+- **Messages**: A class library containing the message definitions.
+- **Endpoint.SqlPersistence**: A console application running the endpoint with SQL persistence.
 
-### Endpoint projects
+### Endpoint project
 
 The endpoint mimics a back-end system. It is configured to use the SQL Server transport. It uses Entity Framework to store business data (orders and shipments).
 
 When the message arrives at the receiver, a single transactional data access context is created to ensure consistency of the entire message-handling process:
 
- * the message is removed from the input queue by the SQL Server transport
- * a new saga instance is created and stored by the SQL persistence
- * a new `Order` entity is created
+- the message is removed from the input queue by the SQL Server transport
+- a new saga instance is created and stored by the SQL persistence
+- a new `Order` entity is created
 
 snippet: StoreOrder
 
- * a new `Shipment` entity is created
+- a new `Shipment` entity is created
 
 snippet: StoreShipment
 
- * a reply message is inserted to the queue
- * a timeout request is inserted to the queue
+- a reply message is inserted to the queue
+- a timeout request is inserted to the queue
 
 Notice how storing the shipment retrieves the `Order` from the session cache of Entity Framework. The `Order` is not yet persisted to the database.
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`
`2`	`2`	`#### Select used by Saga Finder`
`3`	`3`
`4`		`-snippet: MySql_SagaSelectSql`
	`4`	`+snippet: MySql_SagaSelectSql`