Skip to content

doc: initial guide to the plugin #78

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 10 commits into from
Apr 11, 2025
Merged

doc: initial guide to the plugin #78

merged 10 commits into from
Apr 11, 2025

Conversation

fioan89
Copy link
Collaborator

@fioan89 fioan89 commented Apr 10, 2025

The following topics are covered:

  • documentation on how to install the plugin
  • URI handling documentation
  • release procedure
  • resolves Document URI schema #64
    This PR also includes:
  • improved Error Reporting for Unresolved Agents, now it shows a clear, human-readable error message instead
  • a rename of project_path query param to folder
  • and a fix to no longer ask for coder deployment details when user wants to install the plugin via URI.

P.S: Some of the topics were copied without shame from the old Coder Gateway plugin.

fioan89 added 7 commits April 10, 2025 21:53
The following topics are covered:

- documentation on how to install the plugin
- URI handling documentation
- release procedure
- resolves #64

P.S: Some of the topics were copied without shame from the old Coder Gateway plugin.
- uri handling tries to automatically resolve a workspace agent.
- right now an exception is raised if the agent is missing or there are multiple agents for a workspace.
- instead we provide a nice human-readable error notification
- the existing uri handling asks for url, workspace name and so on each time a coder toolbox URI is executed.
- however there are cases where users simply want to install the plugin via jetbrains://gatway/com.coder.toolbox
- in that case there is no point to ask for the coder deployment details.
@fioan89 fioan89 requested review from matifali and bcpeinhardt April 10, 2025 21:42
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

Left a few commnets.

@matifali matifali requested review from f0ssel and removed request for bcpeinhardt April 10, 2025 21:50
@fioan89 fioan89 requested a review from matifali April 10, 2025 22:26
- regardless of query params being present
@fioan89 fioan89 merged commit f4710e2 into main Apr 11, 2025
5 checks passed
@fioan89 fioan89 deleted the document-uri-handling branch April 11, 2025 14:30
Copy link

@f0ssel f0ssel left a comment

Choose a reason for hiding this comment

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

Great detail on the readme, good stuff 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document URI schema
3 participants