-
Notifications
You must be signed in to change notification settings - Fork 293
Documentation updates for new Platform Health feature #8485
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
rbev
wants to merge
13
commits into
master
Choose a base branch
from
sp-platform-health
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
6e1fd2c
Add new custom checks behaviour to servicepulse page
rbev d6cbeaa
Add new platform health page
rbev 8b11a42
Add some text to the platform health page
rbev 459cca6
Spelling & grammar
rbev e514821
remove invalid words
rbev 0a88bf7
Make note use note formatting
rbev 6e7e3f1
Add .md to internal link
rbev 62d42ff
Remove first-person language
rbev d7068e4
Add screenshots to platform health
rbev f3871e7
Update wording
rbev 76ea6c1
update endpoint connection link image
rbev 86e3bfe
update endpoint connection link image
rbev 10b4175
Apply batched suggestions from code review
rbev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| title: Platform Health | ||
| summary: Describes the Platform Health dashboard | ||
| component: ServicePulse | ||
| related: | ||
| - servicepulse/troubleshooting | ||
| reviewed: 2026-09-03 | ||
| --- | ||
|
|
||
| The Platform Health dashboard provides a central view of the Platform components. | ||
|
|
||
|  | ||
|
|
||
| The main screen of the Platform Health dashboard displays a list of all the Platform components along with their current versions, upgrade availability, and overall health status. Each of these can be expanded to view any alerts and some basic information about the instance configuration. | ||
|
|
||
|  | ||
|
|
||
| #### Opening a Support Case | ||
|
|
||
| The Open Support Case on this page allows you to quickly export a snapshot of the status of your installed Platform components before contacting support. | ||
|  | ||
|
|
||
| Opening a Support Case from the Platform Health dashboard will assist the support team by including an up to date snapshot of the Platform instances and their details. | ||
|
|
||
| > [!NOTE] | ||
| > While ServicePulse does not include sensitive information such as connection strings in the snapshot, it is still recommended that you review the content for any confidential information before sending it to support. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's weird kerning in these screenshots because I didn't have zoom at 100%, can just leave them as placeholders until we are happy.