docs: restructure JetBrains IDE documentation for better user experience #19070
+552
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Restructures JetBrains IDE documentation based on user feedback to reduce cognitive load and provide clearer step-by-step instructions: - Add dedicated PyCharm page with streamlined setup instructions - Add dedicated IntelliJ IDEA page with streamlined setup instructions - Update main JetBrains page to focus on 'Other IDEs' (CLion, GoLand, etc.) - Prominently feature the JetBrains Terraform module for one-click integration - Provide clear time estimates (5 minutes) for setup - Include comprehensive troubleshooting sections - Add advanced configuration examples for different use cases Addresses user confusion about JetBrains Fleet, Gateway, and Toolbox by leading with the recommended approach (Terraform module) while keeping alternative methods available for advanced users. Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
|
|
||
| ## Next Steps | ||
|
|
||
| - [Configure your Python environment in the workspace](../../templates/) |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach ../../templates/ Status: 404 Cannot find: ../../templates/
| ## Next Steps | ||
|
|
||
| - [Configure your Python environment in the workspace](../../templates/) | ||
| - [Set up version control integration](../../../admin/git/) |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach ../../../admin/git/ Status: 404 Cannot find: ../../../admin/git/
|
|
||
| ## Next Steps | ||
|
|
||
| - [Configure your Java/Kotlin environment in the workspace](../../templates/) |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach ../../templates/ Status: 404 Cannot find: ../../templates/
| ## Next Steps | ||
|
|
||
| - [Configure your Java/Kotlin environment in the workspace](../../templates/) | ||
| - [Set up version control integration](../../../admin/git/) |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach ../../../admin/git/ Status: 404 Cannot find: ../../../admin/git/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Restructures JetBrains IDE documentation based on user feedback to reduce cognitive load and provide clearer step-by-step instructions.
Changes Made
New Pages Created
pycharm.md) - Dedicated setup instructions for PyCharm Professionalintellij.md) - Dedicated setup instructions for IntelliJ IDEA UltimateUpdated Pages
index.md) - Now focuses on "Other IDEs" (CLion, GoLand, WebStorm, etc.)manifest.json) - Updated to include new pages in proper orderKey Improvements
🎯 Reduced Cognitive Load
⚡ Clear Recommendations
📋 Step-by-Step Focus
🔧 Terraform Module Integration
registry.coder.com/coder/jetbrains/codermoduleUser Feedback Addressed
✅ Fixed: PyCharm users now have a dedicated page with clear instructions
✅ Fixed: PyCharm and IntelliJ get dedicated pages with step-by-step tutorials
✅ Fixed: Clear time estimates (5 minutes) provided upfront
Content Structure
Testing
This restructuring directly addresses user feedback about needing clear, step-by-step guidance rather than having to figure out which method to use among the various JetBrains tools.