[DSM] Add technology pages for DSM documentation #28983

lkretvix · 2025-04-25T15:45:14Z

What does this PR do? What is the motivation?

https://datadoghq.atlassian.net/browse/DSMON-685

Customers can find it difficult to find what technologies are supported by DSM. In order to do this they need to go to each language and look at the tech libraries there. Let's create an Inversion where users can view the technology and find the languages/libraries that are supported

Also some cleanup on duplicated sections of content, converting to shortcodes

QA

https://docs-staging.datadoghq.com/lucas.kretvix/dsm-add-new-tech-pages/data_streams/technologies/rabbitmq/

Merge instructions

Merge readiness:

Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

…reams

…ibm mq

…link

lkretvix · 2025-04-25T15:48:33Z

content/en/data_streams/technologies/azure_service_bus.md

+<table>
+  <thead>
+    <tr>
+      <th>Language</th>
+      <th>Library</th>
+      <th>Minimal tracer version</th>
+      <th>Recommended tracer version</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><a href="/data_streams/dotnet">.NET</a></td>
+      <td><a href="https://www.nuget.org/packages/Azure.Messaging.ServiceBus">Azure.Messaging.ServiceBus</a></td>
+      <td>2.53.0 </td>
+      <td>2.53.0 or later </td>
+    </tr>
+  </tbody>
+</table>


decided to use html table styling for these for consistency. Some of the tech tables have cells that span multiple columns (kafka's Go language has multiple libraries for ex.)

github-actions · 2025-04-25T15:49:00Z

Preview links (active after the `build_preview` check completes)

New or renamed files

Renamed files

Modified Files

https://docs-staging.datadoghq.com/lucas.kretvix/dsm-add-new-tech-pages/data_streams/

johannbotha · 2025-04-25T16:43:17Z

Thanks for adding these, but it looks like it doesn't scroll to the right section. It takes you to the main page, but the setup matrix is still past the fold.

lkretvix · 2025-04-25T16:44:30Z

Thanks for adding these, but it looks like it doesn't scroll to the right section. It takes you to the main page, but the setup matrix is still past the fold.

@johannbotha Not sure if there's a way to force it. I'm adding the anchor tag there but it doesn't seem to want to scroll 🤔

labbati

Thanks for the work @lkretvix, much clearer than before.

Just a few notes:

Any "Note" that prevents a mis-understanding, should be up front. For example, in kafka.md there is a Note at the bottom related to kafka streams not fully supported. That should be more prominent, e.g. above the table or in any format that you find useful.
I would try to avoid repetition of supported library names, versions, and tracer versions in two places (the tech page and the lang page). I know for experience that they will go out of sync in weeks, not years. At the very least, I would extract them in importable fragments.
In my opinion, it is not clear, from a page such as kafka.md, that they have to click the language name in the table's first column to proceed to per lang instructions. Should we add the language tiles all over again? This makes me question is we should remove the language tiles from the index page, but let's ignore that for a moment.

lkretvix · 2025-04-28T15:06:19Z

Thanks for the work @lkretvix, much clearer than before.

Just a few notes:

Any "Note" that prevents a mis-understanding, should be up front. For example, in kafka.md there is a Note at the bottom related to kafka streams not fully supported. That should be more prominent, e.g. above the table or in any format that you find useful.

I would try to avoid repetition of supported library names, versions, and tracer versions in two places (the tech page and the lang page). I know for experience that they will go out of sync in weeks, not years. At the very least, I would extract them in importable fragments.

In my opinion, it is not clear, from a page such as kafka.md, that they have to click the language name in the table's first column to proceed to per lang instructions. Should we add the language tiles all over again? This makes me question is we should remove the language tiles from the index page, but let's ignore that for a moment.

@labbati

Happy to move the Note section higher up 👍
The repetition is tough to get around. I can give myself a task to move them to shortcodes, but that means every version cell gets its own file. Not impossible to do, just takes time
We do have a callout to go to the language page to see how to set up DSM on those technology pages, do you think that's not enough?

labbati · 2025-04-28T15:53:51Z

The repetition is tough to get around. I can give myself a task to move them to shortcodes, but that means every version cell gets its own file. Not impossible to do, just takes time

That'd be too much, so in this case feel free to ignore my comment. I was thinking more something like having the whole per-lang table to its own file and then maybe tabs, but we can do it once we see things get out of syncs.

We do have a callout to go to the language page to see how to set up DSM on those technology pages, do you think that's not enough?

By callout you mean the language name on the first column, correct? It took me a while to get it as a call to action, but not a blocker for me. I am thinking if it would be worth to replace Java with Setup Java to make it more explicit, but probably worthless.

johannbotha · 2025-04-29T01:18:52Z

Thanks for adding these, but it looks like it doesn't scroll to the right section. It takes you to the main page, but the setup matrix is still past the fold.

@johannbotha Not sure if there's a way to force it. I'm adding the anchor tag there but it doesn't seem to want to scroll 🤔

Can you reach out to the docs folks. The goal of the sidenav is to easily get the users to that matrix. I bet it's something with the sticky header or needing the id tag to match the sidenav.

johannbotha · 2025-04-29T01:25:34Z

Thanks for the work @lkretvix, much clearer than before.
Just a few notes:

Any "Note" that prevents a mis-understanding, should be up front. For example, in kafka.md there is a Note at the bottom related to kafka streams not fully supported. That should be more prominent, e.g. above the table or in any format that you find useful.

I would try to avoid repetition of supported library names, versions, and tracer versions in two places (the tech page and the lang page). I know for experience that they will go out of sync in weeks, not years. At the very least, I would extract them in importable fragments.

In my opinion, it is not clear, from a page such as kafka.md, that they have to click the language name in the table's first column to proceed to per lang instructions. Should we add the language tiles all over again? This makes me question is we should remove the language tiles from the index page, but let's ignore that for a moment.

@labbati

Happy to move the Note section higher up 👍

The repetition is tough to get around. I can give myself a task to move them to shortcodes, but that means every version cell gets its own file. Not impossible to do, just takes time

We do have a callout to go to the language page to see how to set up DSM on those technology pages, do you think that's not enough?

There should be a way to do this without "each cell getting it's own file." We're using Hugo and the markdown rendering engine and hugo supports the use of variables. See https://gohugo.io/templates/introduction/#variables

labbati · 2025-04-29T08:21:16Z

@lkretvix, from my PoV the only real blocker here is the sidenav issue that JJ is mentioning. All the rest is just nice to have and once the sidenav is fixed can be merged 👍🏻

johannbotha

LGTM, thanks @lkretvix !

Would be great to schedule a swarm to add any small things we're missing now that we have a platform for tech specific things.

lkretvix · 2025-04-30T14:39:18Z

/merge

dd-devflow · 2025-04-30T14:39:23Z

View all feedbacks in Devflow UI.

2025-04-30 14:39:23 UTC ℹ️ Start processing command /merge

2025-04-30 14:39:32 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-04-30 14:54:15 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in master is approximately 20m (p90).

2025-04-30 15:11:27 UTC ℹ️ MergeQueue: This merge request was merged

Co-authored-by: cswatt <[email protected]>

lkretvix added 18 commits April 25, 2025 08:44

[DSM] Add technology tiles that go to dead file locations

0c35740

[DSM] Add java and go for kafka

3ead25d

[DSM] Add other libraries for kafka, add callout for kafka streams

bd11f43

[DSM] Update disclaimer and title

ad1b418

[DSM] Test adding custom table styling

1aab3f6

[DSM] Use html for table structure

9e70516

[DSM] Add rabbitmq, sqs, sns, and kinesis technology files in data_st…

c709e54

…reams

[DSM] Provide links to language pages from technology pages

f0b6f55

[DSM] Update links on docs pages

d4d225d

[DSM] Add shortcodes for monitoring-xxx content in data streams

476017f

[DSM] Update more shortcodes in data_streams

3163018

[DSM] Add technology files for google pubsub, azure service bus, and …

5feb88a

…ibm mq

[DSM] Update missing shortcodes and minor typos in data streams docs

0b78f34

[DSM] Add supported languages/technologies to main menu

2b96a99

[DSM] Use relative url in azure service bus .net link

223afc0

[DSM] Convert docs links to relative links, update azure service bus …

3a245e0

…link

[DSM] Move rabbitmq shortcode to different directory

168147a

[DSM] Rename Technology column to Library

477a7ed

github-actions bot added the Architecture Everything related to the Doc backend label Apr 25, 2025

lkretvix commented Apr 25, 2025

View reviewed changes

[DSM] Add rabbitmq callout on rabbitmq page

bba231c

lkretvix marked this pull request as ready for review April 25, 2025 16:35

lkretvix requested review from a team as code owners April 25, 2025 16:35

jhgilbert added the editorial review Waiting on a more in-depth review label Apr 25, 2025

[DSM] Add note about where to go to setup DSM on tech pages

5bbac1e

labbati reviewed Apr 28, 2025

View reviewed changes

[DSM] Move kafka streams note above table on kafka page

8b626f9

rearrange

1888215

lkretvix requested review from labbati and johannbotha April 29, 2025 20:45

johannbotha approved these changes Apr 29, 2025

View reviewed changes

nsollecito approved these changes Apr 29, 2025

View reviewed changes

dd-devflow bot added the mergequeue-status: waiting label Apr 30, 2025

cswatt approved these changes Apr 30, 2025

View reviewed changes

dd-devflow bot added mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: waiting mergequeue-status: queued labels Apr 30, 2025

lkretvix removed the request for review from labbati April 30, 2025 14:59

dd-mergequeue bot merged commit fb9c40f into master Apr 30, 2025
24 of 29 checks passed

dd-mergequeue bot deleted the lucas.kretvix/dsm-add-new-tech-pages branch April 30, 2025 15:11

dd-devflow bot added mergequeue-status: done and removed mergequeue-status: in_progress labels Apr 30, 2025

estherk15 pushed a commit that referenced this pull request May 8, 2025

[DSM] Add technology pages for DSM documentation (#28983)

2c6e7e4

Co-authored-by: cswatt <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[DSM] Add technology pages for DSM documentation #28983

[DSM] Add technology pages for DSM documentation #28983

Uh oh!

lkretvix commented Apr 25, 2025 •

edited

Loading

Uh oh!

lkretvix Apr 25, 2025

Uh oh!

github-actions bot commented Apr 25, 2025 •

edited

Loading

Uh oh!

johannbotha commented Apr 25, 2025

Uh oh!

lkretvix commented Apr 25, 2025

Uh oh!

labbati left a comment •

edited

Loading

Uh oh!

lkretvix commented Apr 28, 2025

Uh oh!

labbati commented Apr 28, 2025 •

edited

Loading

Uh oh!

johannbotha commented Apr 29, 2025

Uh oh!

johannbotha commented Apr 29, 2025

Uh oh!

labbati commented Apr 29, 2025

Uh oh!

johannbotha left a comment

Uh oh!

lkretvix commented Apr 30, 2025

Uh oh!

dd-devflow bot commented Apr 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

[DSM] Add technology pages for DSM documentation #28983

[DSM] Add technology pages for DSM documentation #28983

Uh oh!

Conversation

lkretvix commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do? What is the motivation?

QA

Merge instructions

Additional notes

Uh oh!

lkretvix Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview links (active after the build_preview check completes)

New or renamed files

Renamed files

Modified Files

Uh oh!

johannbotha commented Apr 25, 2025

Uh oh!

lkretvix commented Apr 25, 2025

Uh oh!

labbati left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lkretvix commented Apr 28, 2025

Uh oh!

labbati commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johannbotha commented Apr 29, 2025

Uh oh!

johannbotha commented Apr 29, 2025

Uh oh!

labbati commented Apr 29, 2025

Uh oh!

johannbotha left a comment

Choose a reason for hiding this comment

Uh oh!

lkretvix commented Apr 30, 2025

Uh oh!

dd-devflow bot commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lkretvix commented Apr 25, 2025 •

edited

Loading

github-actions bot commented Apr 25, 2025 •

edited

Loading

Preview links (active after the `build_preview` check completes)

labbati left a comment •

edited

Loading

labbati commented Apr 28, 2025 •

edited

Loading

dd-devflow bot commented Apr 30, 2025 •

edited

Loading