Skip to content
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

Merged
merged 4 commits into from
Sep 7, 2023

Conversation

hardikbajaj
Copy link
Contributor

@hardikbajaj hardikbajaj commented Aug 27, 2023

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:

  • been self-reviewed.
  • added documentation for new or modified features or behaviors.
  • a release note entry in the PR description.
  • added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
  • added or updated version, license, or notice information in licenses.yaml
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added unit tests or modified existing tests to cover new code paths, ensuring the threshold for code coverage is met.
  • added integration tests.
  • been tested in a test Druid cluster.

@hardikbajaj hardikbajaj changed the title Draft Pr Updated documentation for OshiSysMonitor Aug 27, 2023
## Sys
## Sys [Deprecated]

> SysMonitor is now deprecated and will be removed in future releases.
Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Contributor

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:

Suggested change
> 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.
:::

Copy link
Contributor

@ektravel ektravel left a 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>
@abhishekagarwal87 abhishekagarwal87 merged commit e100b18 into apache:master Sep 7, 2023
10 checks passed
@LakshSingla LakshSingla added this to the 28.0 milestone Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants