-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
Updated documentation for OshiSysMonitor #14912
Conversation
## Sys | ||
## Sys [Deprecated] | ||
|
||
> SysMonitor is now deprecated and will be removed in future releases. |
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.
Consider changing lines 411 and 412 to regular text. Some readers skip elements, including notices, that are outside their focus of interest.
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.
Sure, should I add it in ::: info wrapper instead like here . I've seen some deprecation notices in this repo put this way
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.
Yes, please. Let's use the special admonitions syntax:
> SysMonitor is now deprecated and will be removed in future releases. | |
:::info | |
SysMonitor is now deprecated and will be removed in future releases. Instead, use the new OSHI monitor called [OshiSysMonitor](#oshisysmonitor). The new monitor has a wider support for different machine architectures including ARM instances. | |
::: |
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.
Thank you for making these changes, @hardikbajaj. Left a few suggestions.
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
Fixes #XXXX.
Description
Updates documentation for OshiSysMontior. Accidentally #14799 got closed which was initial PR and has all the details, modified all suggestions here
Fixed the bug ...
Renamed the class ...
Added a forbidden-apis entry ...
Release note
Key changed/added classes in this PR
MyFoo
OurBar
TheirBaz
This PR has: