Skip to content

Commit

Permalink
Docs review andreas (#6900)
Browse files Browse the repository at this point in the history
* Docs review deployment options

* Docs review custom checks

* Docs review platform sample

* Docs review high-level content

* Update monitoring/custom-checks/in-servicepulse.md

Co-authored-by: Poornima Nayar <[email protected]>

* Update platform-sample-package.md

---------

Co-authored-by: Poornima Nayar <[email protected]>
  • Loading branch information
andreasohlund and poornimanayar authored Nov 6, 2024
1 parent 69bf4ee commit f7f264d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion get-started/high-level-content.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: High-level content
summary: Recommended articles to gain an understanding of the key concepts and technologies used within the Particular Service Platform
reviewed: 2022-03-18
reviewed: 2024-11-06
---

These articles are recommended to gain an understanding of the key concepts and technologies used within the Particular Service Platform.
Expand Down
4 changes: 2 additions & 2 deletions monitoring/custom-checks/in-servicepulse.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Managing custom checks in ServicePulse
summary: Describes how ServicePulse monitors custom check activity
reviewed: 2022-03-11
reviewed: 2024-11-06
redirects:
- servicepulse/intro-endpoints-custom-checks
---
Expand All @@ -24,7 +24,7 @@ When a custom check fails, it will continue to make the main Custom Checks badge

Sometimes a custom check reports an error that is easily solved. The status of the custom check will not be updated in ServicePulse until the custom check is executed again.

If it is a one-off custom check, then the endpoint hosting it will need to be restarted to execute the custom check again. If it is a periodic custom check, then it will be automatically executed again after the scheduled period.
If it is a one-off custom check, the endpoint hosting the check will need to be restarted to execute it again. If it is a periodic custom check, it will be automatically executed again after the scheduled period.

Rather than waiting for the failing custom check to be executed again to update its status, it can be muted. Muted custom checks are removed from ServicePulse and will not contribute to the main custom checks dashboard badge.

Expand Down
6 changes: 3 additions & 3 deletions platform/platform-sample-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Platform Sample installation
summary: Installation instructions for using the platform sample for demo purposes.
component: PlatformSample
reviewed: 2022-03-11
reviewed: 2024-11-06
---

The [Platform Sample package](https://www.nuget.org/packages/Particular.PlatformSample) is a portable version of the Particular Service Platform which can be used to demonstrate the platform without installing it. This is the easiest way to experience the Particular Service Platform.
Expand Down Expand Up @@ -36,7 +36,7 @@ The Platform Sample package performs the following when the Console App is start

### Showing console output

By default, console output from ServiceControl and ServiceControl.Monitoring is suppressed. For debugging or curiosity, console output may be shown by specifying:
By default, the console output from ServiceControl and ServiceControl.Monitoring is suppressed. For debugging or curiosity, console output may be shown by specifying:

snippet: ShowConsoleOutput

Expand All @@ -55,4 +55,4 @@ The [message replay tutorial](/tutorials/message-replay) is a sample that uses t
To use ServiceInsight with the sample, [download](https://github.com/Particular/serviceinsight/releases/latest) and install ServiceInsight. After starting ServiceInsight, connect to ServiceControl using the [Endpoint Explorer](/serviceinsight/#endpoint-explorer) at, for example, `http://localhost:49200/api`.

> [!NOTE]
> The Platform Sample package will search for available ports and then display the ports being used. The actual ServiceControl port that needs to be used in the Endpoint Explorer can be seen in the output.
> The Platform Sample package will search for available ports and then display the ports being used. The actual ServiceControl port that needs to be used in the Endpoint Explorer can be seen in the output.
2 changes: 1 addition & 1 deletion transports/sql/deployment-options.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deployment options
reviewed: 2022-02-28
reviewed: 2024-11-06
component: SqlTransport
related:
- nservicebus/operations
Expand Down

0 comments on commit f7f264d

Please sign in to comment.