Skip to content

Conversation

@pierreln-dd
Copy link
Contributor

Issue with link to mongodb atlas

see also /layouts/shortcodes/dbm-mongodb-agent-data-collected.md

What does this PR do? What is the motivation?

Merge instructions

  • Please merge after reviewing

Additional notes

Issue with link to mongodb atlas

see also /layouts/shortcodes/dbm-mongodb-agent-data-collected.md
@pierreln-dd pierreln-dd requested review from a team as code owners September 25, 2024 11:27
@drichards-87 drichards-87 self-assigned this Sep 25, 2024
@drichards-87 drichards-87 added the editorial review Waiting on a more in-depth review label Sep 25, 2024
@drichards-87
Copy link
Contributor

Hi @pierreln-dd. Just to confirm, the main issue is that that the link in the Data Collected section for MongoDB Atlas is pointing to the API and Application Keys article, and not the metrics table for the MongoDB Atlas integration?

Looking at the dbm-mongodb-agent-data-collected.md shortcode, I can see there's a link without a destination URL. I can add the destination URL, which should be https://docs.datadoghq.com/integrations/mongodb_atlas/#data-collected, correct?

@pierreln-dd
Copy link
Contributor Author

@drichards-87 Yes, that's correct. the shortcode link is [2] which seems to pick up the [2] from the mongodbatlas.md file, which is why I only made changes in that file to simplify things since the shortcode also picks up [2] from /setup_mongodb/selfhosted.md
So if we change the shortcode to mongodb atlas, it will create another issue with the seflhosted file
Hope that makes sense

@drichards-87
Copy link
Contributor

@pierreln-dd Yes, that makes sense. I think the challenge here is that the shortcode is intended to have a destination URL at the bottom of the file, and right now it doesn't. Someone else might come along, see that it doesn't, and then try adding a link. That would undo what you're trying to accomplish with this PR.

As an alternative, I think we could move the Metrics heading outside of the shortcode. That would mean we would have copies of the same content in both articles, but at least this way, we can specify a unique destination URL for each article.

@pierreln-dd
Copy link
Contributor Author

@drichards-87 , I'm open to either, I was just looking to make the simplest edit that fixed the issue. I also wasn't sure what was "best practice" for this kind of case.
Do you want me to make those changes?

@drichards-87
Copy link
Contributor

@pierreln-dd I went ahead and created a separate PR 25466 that moves the Metrics section outside of the shortcode. Let me know if that works for you. (And also if the links are pointing to the correct/expected URLs.) In the meantime, I'll close this PR in favor of the new one I created.

@pierreln-dd pierreln-dd deleted the pierreln-dd-patch-mongodb-atlas-link-fix branch November 8, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants