Skip to content

docs: reorganize JetBrains docs #17995

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 8 commits into from
May 30, 2025
Merged

docs: reorganize JetBrains docs #17995

merged 8 commits into from
May 30, 2025

Conversation

matifali
Copy link
Member

@matifali matifali commented May 22, 2025

This pull request introduces significant updates to documentation and references related to JetBrains IDEs, including rebranding, restructuring, and adding new guides.

Preview

@matifali matifali self-assigned this May 22, 2025
@matifali matifali requested a review from Copilot May 22, 2025 18:30
@matifali matifali force-pushed the atif/jetbrains-reorganization branch from a4898a7 to a7153f3 Compare May 22, 2025 18:33
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes and clarifies JetBrains integration docs by moving pre-install content to the admin templates, introducing dedicated guides for Gateway and Fleet, and updating navigation links and README entries.

  • Add standalone gateway.md and fleet.md in user guides
  • Rename/move pre-install and air-gapped docs under admin templates
  • Update manifest.json, offline.md, and README.md to reflect new paths and add the Toolbox plugin

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/user-guides/workspace-access/jetbrains/toolbox.md Mark Toolbox integration as beta
docs/user-guides/workspace-access/jetbrains/index.md Simplify IDE list and add admon
docs/user-guides/workspace-access/jetbrains/gateway.md New dedicated JetBrains Gateway guide
docs/user-guides/workspace-access/jetbrains/fleet.md New dedicated JetBrains Fleet guide
docs/manifest.json Update JetBrains section, add state flags, rename/move entries
docs/install/offline.md Point offline guide to admin preinstall doc
docs/admin/templates/extending-templates/jetbrains-preinstall.md Rename and update pre-install template instructions
docs/admin/templates/extending-templates/jetbrains-airgapped.md Rename and update air-gapped instructions
Comments suppressed due to low confidence (1)

docs/install/offline.md:256

  • [nitpick] This offline install guide currently links to the pre-install template guide; to better cover offline deployment steps, consider linking to jetbrains-airgapped.md instead of the preinstall template.
+[has documented offline deployment steps.](../admin/templates/extending-templates/jetbrains-preinstall.md)

@matifali matifali force-pushed the atif/jetbrains-reorganization branch 3 times, most recently from d790991 to 9a91b0e Compare May 22, 2025 19:23
- Add new information on JetBrains Toolbox and Fleet integration.
- Rename files for better organization and to reflect content changes.
- Remove outdated JetBrains Gateway documentation and consolidate info.
- Adjust paths and links for offline support in JetBrains IDEs.
- Update manifest for consistency and navigation improvements.
@matifali matifali force-pushed the atif/jetbrains-reorganization branch from 9a91b0e to 71e77b0 Compare May 22, 2025 20:03
@matifali matifali marked this pull request as ready for review May 22, 2025 20:05
@matifali matifali requested a review from EdwardAngert May 22, 2025 20:05
@matifali matifali requested a review from bpmct May 24, 2025 05:52
@Nilzkool
Copy link

Hi @matifali, I noticed you’ve been keeping docs up-to-date, always good to see.

I built a small LLM-based tool for maintaining higher-level docs (SDK guides, READMEs, tutorials). It auto-updates them on PRs to prevent drift.

No pressure at all, but thought it might be useful: https://github.com/marketplace/deepdocsai

@matifali matifali requested a review from ericpaulsen May 27, 2025 07:49
@matifali matifali requested a review from EdwardAngert May 29, 2025 16:38
@matifali matifali merged commit 25e2146 into main May 30, 2025
33 of 35 checks passed
@matifali matifali deleted the atif/jetbrains-reorganization branch May 30, 2025 00:56
@github-actions github-actions bot locked and limited conversation to collaborators May 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants