-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Conversation
Preview links (active after the
|
@jfree I pushed two commits to update the draft:
Assuming these updates look good to you, the PR should be ready to merge with a |
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".
These changes are great, thanks! |
Essentially rolls back 29cb3c2, and adds 4th nesting level
This diff shows my latest changes, relocating the Live Debugger page nested under JetBrains: ![]() 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. |
/merge |
View all feedbacks in Devflow UI.
The expected merge time in
|
…Es (#28830) Co-authored-by: joepeeples <joe.peeples@datadoghq.com>
…Es (#28830) Co-authored-by: joepeeples <joe.peeples@datadoghq.com>
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:
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:
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.