Editor Extensions Runbook
Editor Extensions
Section titled “Editor Extensions”The Editor Extensions group is a collection of editors that extend GitLab features to developers across multiple phases of the DevSecOps cycle. Each contains its own quirks and deployment requirements. This runbook aims to place all that information in once space. If anything is missing, contribute to this runbook to keep it up to date.
We currently support these editors:
- Visual Studio Code
~Editor Extensions::VS Code - Microsoft Visual Studio
~Editor Extensions::Visual Studio - JetBrains
~Editor Extensions::JetBrains - Eclipse
~Editor Extensions::Eclipse - Neovim
~Editor Extensions::NeoVim
This group also uses the labels ~Group::editor extensions, ~Category:Editor Extensions, ~Editor Extensions::All
Install and setup
Section titled “Install and setup”Each editor has its own steps for installation and setup:
Editor extensions are integrated with the GitLab Language Server. If that setup is required for any part of your troubleshooting, please check out the GitLab project page.
Troubleshooting
Section titled “Troubleshooting”Each editor has its own troubleshooting documentation:
Request developer assistance and report bugs
Section titled “Request developer assistance and report bugs”Whether requesting developer assistance on a customer issue or submitting a bug report, the Editor Extensions team works most efficiently when provided with all required information for support.
Use the Dev Request for Help issue template to create a support issue for engineers on the Editor Extension team.
To help you fill out the template completely, see these pages for editor-specific instructions for gathering the information we need:
Required information for Support (RIFS)
Section titled “Required information for Support (RIFS)”- Visual Studio Code RIFS
- Microsoft Visual Studio RIFS
- JetBrains RIFS
- Eclipse RIFS
- NeoVim RIFS (Coming soon)
Note: We aim to enhance this process by automating the collection of user environment details in the future.
Contacting the Editor Extensions team
Section titled “Contacting the Editor Extensions team”To streamline issue tracking and resolution, the preferred method for submitting an issue is to create a Dev Request for Help issue. Submitting an issue in this way will automatically notify the engineering manager who will triage and assign an appropriate developer for investigation.
For urgent matters, where all required information has already been collected, reach out via the appropriate Slack channel:
- Eclipse plugin:
#f_eclipse_plugin - JetBrains plugin:
#f_jetbrains_plugin - Microsoft Visual Studio extension:
#f_visual_studio_extension - Neovim Plugin:
#f_neovim_plugin - Visual Studio Code extension:
#f_vscode_extension - General inquiries affecting multiple extensions:
#g_editor_extensions
Documentation repository and knowledge base
Section titled “Documentation repository and knowledge base”This section is a centralized reference for troubleshooting Editor Extensions across multiple IDEs. Given the varying levels of maturity for different editor integrations, documentation might not yet exist for all extensions.
If documentation is unavailable for a specific extension:
- See the Contacting the Editor Extensions team section for guidance.
- Contribute directly to this documentation or a specific editor’s documentation pages.
Add a new editor
Section titled “Add a new editor”If adding a new editor, update this runbook and create documentation to reflect the work done for other editors.