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

Fix link to renamed and reformatted spec #122

Merged
merged 4 commits into from
Aug 16, 2023

Conversation

ccho-mongodb
Copy link
Contributor

@ccho-mongodb ccho-mongodb commented Aug 16, 2023

Pull Request Info

PR Reviewing Guidelines

JIRA - None
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/081623-fix-broken-links/fundamentals/monitoring/#server-discovery-and-monitoring-events

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?

@@ -148,17 +148,15 @@ The driver defines nine SDAM events. The driver divides these nine events
between three separate listener interfaces which each listen for three of the
nine events. Here are the three interfaces and the events they listen for:

- ``ClusterListener``: :spec:`topology </server-discovery-and-monitoring/server-discovery-and-monitoring.rst#topology>`
related events
- ``ClusterListener``: topology related events
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a Java/Kotlin event name and doesn't seem to correspond to anything in the spec, so I don't think the spec should be linked.

Copy link
Collaborator

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -148,17 +148,15 @@ The driver defines nine SDAM events. The driver divides these nine events
between three separate listener interfaces which each listen for three of the
nine events. Here are the three interfaces and the events they listen for:

- ``ClusterListener``: :spec:`topology </server-discovery-and-monitoring/server-discovery-and-monitoring.rst#topology>`
related events
- ``ClusterListener``: topology related events
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: hyphen for clarity (compound modifier)

Suggested change
- ``ClusterListener``: topology related events
- ``ClusterListener``: topology-related events

@ccho-mongodb ccho-mongodb merged commit 49ad33b into mongodb:master Aug 16, 2023
3 checks passed
@ccho-mongodb ccho-mongodb deleted the 081623-fix-broken-links branch August 16, 2023 22:03
ccho-mongodb pushed a commit that referenced this pull request Aug 16, 2023
@docs-builder-bot
Copy link
Collaborator

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