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: broken link in document.js #10190

Merged
merged 1 commit into from
Apr 29, 2021
Merged

Conversation

joostdecock
Copy link
Contributor

This links to an anchor, but the target is on a different page, so this link is broken.

I checked the other links to see how to link, but there are three different approaches used throughout the docs:

  • Relative links: /docs/api/model.html#model_Model.replaceOne
  • http links: http://mongoosejs.com/docs/api/model.html#model_Model.replaceOne
  • https links: https://mongoosejs.com/docs/api/model.html#model_Model.replaceOne

I opted for the https link (https://mongoosejs.com/docs/api/model.html#model_Model.replaceOne) since that seemed like the best choice to me.

Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory.

If you're making a change to documentation, do not modify a .html file directly. Instead find the corresponding .pug file or test case in the test/docs directory.

Summary

Examples

This links to an anchor, but the target is on a different page, so this link is broken.

I checked the other links to see how to link, but there are three different approaches used throughout the docs:

 - Relative links: `/docs/api/model.html#model_Model.replaceOne`
 - http links: `http://mongoosejs.com/docs/api/model.html#model_Model.replaceOne`
 - https links: `https://mongoosejs.com/docs/api/model.html#model_Model.replaceOne`

I opted for the https link (`https://mongoosejs.com/docs/api/model.html#model_Model.replaceOne`) since that seemed like the best choice to me.
Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

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

Thanks 👍

@vkarpov15 vkarpov15 merged commit 2938199 into Automattic:master Apr 29, 2021
@vkarpov15 vkarpov15 added this to the 5.12.7 milestone Apr 29, 2021
@vkarpov15 vkarpov15 added the docs This issue is due to a mistake or omission in the mongoosejs.com documentation label Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is due to a mistake or omission in the mongoosejs.com documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants