Skip to content

Initial docs for Live Debugger tab in Datadog plugin for JetBrains IDEs #28830

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

Merged
merged 17 commits into from
Apr 30, 2025

Conversation

jfree
Copy link
Contributor

@jfree jfree commented Apr 17, 2025

What does this PR do? What is the motivation?

Adds documentation for the Live Debugger feature that has been added to the upcoming release of the Datadog plugin for JetBrains IDEs.

Merge instructions

Please hold the merge until we have released the latest version of the plugin.

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

I've created a separate page for the Live Debugger documentation as it is likely to grow over time and the existing page for the Datadog plugin for JetBrains is already quite long. It would make sense also to move the Continuous Profiler docs to a separate page, but that can be done in a later PR.

@jfree jfree requested a review from a team as a code owner April 17, 2025 07:04
@github-actions github-actions bot added the Images Images are added/removed with this PR label Apr 17, 2025
Copy link
Contributor

github-actions bot commented Apr 17, 2025

@joepeeples joepeeples added the editorial review Waiting on a more in-depth review label Apr 17, 2025
@joepeeples joepeeples self-assigned this Apr 17, 2025
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Apr 18, 2025
@joepeeples
Copy link
Contributor

joepeeples commented Apr 18, 2025

@jfree I pushed two commits to update the draft:

  • 29cb3c2 - Adds the new Live Debugger page to the left navigation menu. This relocates the page at the same level as the main IDE pages, because the nav typically only allows 2 nesting levels. Also if we eventually add the Live Debugger to other IDEs in the future, it'd be better to have the page in a neutral spot instead of under a specific IDE.

    I also added a product identifier tag at the top to help link it to the JetBrains IDEs page.

    image
  • 596108c - Applies various line edits and small revisions to match our style guidelines. The commit diff makes it pretty clear to see what I changed; we can keep revising anything needs to be reverted, etc.

    This also crops the images to remove drop shadows and white space, again to match our typical style for images.

Assuming these updates look good to you, the PR should be ready to merge with a /merge comment. Thanks for preparing this content!

@jfree
Copy link
Contributor Author

jfree commented Apr 22, 2025

29cb3c2 - Adds the new Live Debugger page to the left navigation menu. This relocates the page at the same level as the main IDE pages, because the nav typically only allows 2 nesting levels. Also if we eventually add the Live Debugger to other IDEs in the future, it'd be better to have the page in a neutral spot instead of under a specific IDE.

I'm not sure that this will work well. While it is our goal to have feature parity across the IDEs, the implementations look very different between the JetBrains IDEs and the VS Code extension. The majority of developers use one or the other IDE but not both, so I think it makes sense for us to take on some duplication with the docs and provide IDE-specific versions for the features. That way we can use IDE-specific language ("action" vs "command" for example) to describe features, plus IDE-specific screenshots, and not require the user to navigate some generic descriptions to understand how the feature works in their specific IDE. So this is why, at least for now, we've prepared the docs "per IDE".

596108c - Applies various line edits and small revisions to match our style guidelines.

These changes are great, thanks!

Essentially rolls back 29cb3c2, and adds 4th nesting level
@joepeeples joepeeples requested a review from a team as a code owner April 22, 2025 19:56
@joepeeples
Copy link
Contributor

This diff shows my latest changes, relocating the Live Debugger page nested under JetBrains:

image

Adding a 4th-level nav page requires an override in the Docs system code, so now the PR will need approval from the Websites team; once I know the PR passes CI, I'll follow up with them to get that review.

@jfree
Copy link
Contributor Author

jfree commented Apr 30, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Apr 30, 2025

View all feedbacks in Devflow UI.

2025-04-30 16:21:27 UTC ℹ️ Start processing command /merge


2025-04-30 16:21:32 UTC ℹ️ MergeQueue: pull request added to the queue

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


2025-04-30 16:37:29 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 69f2b60 into master Apr 30, 2025
19 of 21 checks passed
@dd-mergequeue dd-mergequeue bot deleted the david.gilbert/IDE-4301-live-debug branch April 30, 2025 16:37
aldrickdev pushed a commit that referenced this pull request May 7, 2025
…Es (#28830)

Co-authored-by: joepeeples <joe.peeples@datadoghq.com>
estherk15 pushed a commit that referenced this pull request May 8, 2025
…Es (#28830)

Co-authored-by: joepeeples <joe.peeples@datadoghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants