Skip to content

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

Merged
merged 3 commits into from
Sep 10, 2024

Conversation

mcmorisi
Copy link
Collaborator

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

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link

netlify bot commented Aug 27, 2024

Deploy Preview for docs-java-rs ready!

Name Link
🔨 Latest commit f0fcf5c
🔍 Latest deploy log https://app.netlify.com/sites/docs-java-rs/deploys/66ce0e5b6b0f300008256f4c
😎 Deploy Preview https://deploy-preview-82--docs-java-rs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@stephmarie17 stephmarie17 self-requested a review August 27, 2024 15:35
Copy link
Collaborator

@stephmarie17 stephmarie17 left a 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 💬

.. 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.
Copy link
Collaborator

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:

Suggested change
#. Press :guilabel:`Insecure Connection` in the warning dialog box.
#. Click :guilabel:`Insecure Connection` in the warning dialog box.

Comment on lines 369 to 370
When you no longer want to inspect your connection pools in JConsole, do the
following:
Copy link
Collaborator

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:

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

Comment on lines 372 to 373
- Exit JConsole by closing the JConsole window
- Stop the Java program running the preceding code snippet
Copy link
Collaborator

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.

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

@mcmorisi mcmorisi requested review from a team and vbabanin and removed request for a team August 27, 2024 17:36
@mcmorisi mcmorisi requested a review from rozza September 5, 2024 15:36
Copy link
Member

@rozza rozza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mcmorisi mcmorisi merged commit 72c693c into mongodb:main Sep 10, 2024
5 checks passed
@mcmorisi mcmorisi deleted the DOCSP-42300-monitoring branch September 10, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants