Move IDE Plugins docs [DOCS-13381] - redux#34777
Conversation
still need to check a lot of elements: - frontmatter metadata - links (esp Further Reading) - etc etc
excluding Further Reading (separate commit)
The updates were lost by Git because in our PR, the file containing the updates is deleted. So I had to manually apply the updates in this commit
Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com>
github-actions
Bot
added
Architecture
joepeeples
changed the base branch from
master
to
joepeeples/12834-reorg-sci
brett0000FF
left a comment
brett0000FF
left a comment
There was a problem hiding this comment.
LGTM other than the two small suggestions! Note that the preview links aren't working--guessing because this isn't targeting main? We'll want to do a final check on the links for the PR this merges into.
| </div> | ||
| <div class="col"> | ||
| <a class="card h-100" href="/developers/ide_plugins/vscode/#static-analysis/"> | ||
| <a class="card h-100" href="/ide_plugins/vscode/#static-analysis/"> |
There was a problem hiding this comment.
| <a class="card h-100" href="/ide_plugins/vscode/#static-analysis/"> | |
| <a class="card h-100" href="/ide_plugins/idea/#static-analysis/"> |
I think this is the correct link, but there is no static analysis heading on the Jetbrains page.
There was a problem hiding this comment.
I think it's the other way around; this div is for VS Code so this URL is OK, but the one above is for JetBrains and has an incorrect URL (on line 6).
BUT it's probably moot because I suspect these partials are no longer in use; I couldn't find any references to them in the repo. For now, I'll fix the URLs to point to the correct top-level pages, but will look into removing the partials in a future PR.
| {{< whatsnext desc="See the documentation for information about the following integrations:">}} | ||
| {{< nextlink href="developers/ide_plugins/idea/#static-analysis" >}}<u>JetBrains IDEs</u>: IntelliJ IDEA, GoLand, PyCharm, RubyMine, WebStorm, and PhpStorm{{< /nextlink >}} | ||
| {{< nextlink href="developers/ide_plugins/vscode/#static-analysis" >}}<u>Visual Studio Code</u>{{< /nextlink >}} | ||
| {{< nextlink href="ide_plugins/idea/#static-analysis" >}}<u>JetBrains IDEs</u>: IntelliJ IDEA, GoLand, PyCharm, RubyMine, WebStorm, and PhpStorm{{< /nextlink >}} |
There was a problem hiding this comment.
Note that there is no static analysis section on the Jetbrains page.
There was a problem hiding this comment.
This looks like a preexisting broken link, probably from earlier reorgs of these pages. Rather than setting up another brittle link to a subsection, I'll point both of these to the top-level pages, which are less likely to change.
Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com>
…/documentation into joepeeples/13381-move-ides-redux
3 participants
What does this PR do? What is the motivation?
This PR is a re-attempt of #34546, which got all weird due to rebasing shenanigans. I decided to start over with a clean PR.
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass 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.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes