Skip to content

docs(NODE-4295): ensure all change stream events have links to their documentation #4051

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 27, 2024
Merged

docs(NODE-4295): ensure all change stream events have links to their documentation #4051

merged 1 commit into from
Mar 27, 2024

Conversation

baileympearson
Copy link
Contributor

@baileympearson baileympearson commented Mar 22, 2024 •
edited by nbbeeken
Loading

Description

What is changing?

  • Update change stream links
Is there new documentation needed for these changes?

No.

What is the motivation for this change?

  • Make change stream documentation links more specific to change event types

Double check the following

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@baileympearson baileympearson marked this pull request as ready for review March 22, 2024 15:37
@baileympearson baileympearson changed the title chore(NODE-4295): ensure all change stream events have links to their documentation docs(NODE-4295): ensure all change stream events have links to their documentation Mar 22, 2024
@aditi-khare-mongoDB aditi-khare-mongoDB self-requested a review March 25, 2024 20:51
@aditi-khare-mongoDB aditi-khare-mongoDB added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Mar 25, 2024
aditi-khare-mongoDB
aditi-khare-mongoDB suggested changes Mar 25, 2024
View reviewed changes
Copy link
Contributor

@aditi-khare-mongoDB aditi-khare-mongoDB left a comment

Choose a reason for hiding this comment

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

Can we add a small release highlight stating that the links are now fixed / changed? This is a public facing feature.

@aditi-khare-mongoDB aditi-khare-mongoDB self-assigned this Mar 26, 2024
@baileympearson
Copy link
Contributor Author

@aditi-khare-mongoDB We generally omit docs-only changes (even to publicly facing features) from our changelog and release notes

@nbbeeken nbbeeken merged commit 2634ea3 into mongodb:main Mar 27, 2024
23 of 26 checks passed
aditi-khare-mongoDB pushed a commit that referenced this pull request Apr 5, 2024
@baileympearson @aditi-khare-mongoDB
docs(NODE-4295): ensure all change stream events have links to their …
8583a10 
…documentation (#4051)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aditi-khare-mongoDB aditi-khare-mongoDB aditi-khare-mongoDB requested changes

@nbbeeken nbbeeken nbbeeken approved these changes

Assignees

@aditi-khare-mongoDB aditi-khare-mongoDB

Labels
Primary Review In Review with primary reviewer, not yet ready for team's eyes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@baileympearson @nbbeeken @aditi-khare-mongoDB