-
Notifications
You must be signed in to change notification settings - Fork 17
DOCSP-42300: Standardize Monitoring page #82
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
Conversation
✅ Deploy Preview for docs-java-rs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
LGTM! A few small comments 💬
source/monitoring.txt
Outdated
.. tip:: Consult the Official JMX and JConsole Documentation | ||
|
||
The descriptions of JMX and JConsole in this example are illustrative | ||
rather than a source of truth. For guaranteed up to date information, consult |
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.
rather than a source of truth. For guaranteed up to date information, consult | |
rather than a source of truth. For guaranteed up-to-date information, consult |
source/monitoring.txt
Outdated
Once JConsole is open, perform the following actions in the GUI: | ||
|
||
#. Select the Java process running the preceding example code. | ||
#. Press :guilabel:`Insecure Connection` in the warning dialog box. |
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.
[s] In the style guide, it sounds like press
is reserved for a specific key on a keyboard, but not super familiar with JConsole so possibly that is a better choice so might not need to update:
#. Press :guilabel:`Insecure Connection` in the warning dialog box. | |
#. Click :guilabel:`Insecure Connection` in the warning dialog box. |
source/monitoring.txt
Outdated
When you no longer want to inspect your connection pools in JConsole, do the | ||
following: |
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.
[s] To better align with the introducing lists section of the style guide:
When you no longer want to inspect your connection pools in JConsole, do the | |
following: | |
When you no longer want to inspect your connection pools in JConsole, perform the | |
following tasks: |
source/monitoring.txt
Outdated
- Exit JConsole by closing the JConsole window | ||
- Stop the Java program running the preceding code snippet |
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.
[q] Do these need to be completed in order or it doesn't matter? Also I think can use punctuation as imperative statements.
- Exit JConsole by closing the JConsole window | |
- Stop the Java program running the preceding code snippet | |
- Exit JConsole by closing the JConsole window. | |
- Stop the Java program running the preceding code snippet. |
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.
LGTM
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-42300
Staging - https://preview-mongodbmcmorisi.gatsbyjs.io/java-rs/DOCSP-42300-monitoring/monitoring/
Self-Review Checklist