Create remote-ssh-stable-commands.md #7725
Conversation
Closes #7549 We got this request from an extension developer, in addition to just writing this doc we would have to commit to maintaining these functions. I think this is reasonable given how vital they are to the core functionality of the Remote-SSH extension. If this is carried through, comments should be added alongside the functions and the interface to alert future developers.
|
Another note- this could also go in the remote-release wiki. I am not sure which is a better spot for it. |
eleanorjboyd
changed the title
remote-ssh-stable-commands.md
Outdated
| `opensshremotes.cleanDevBox` - This command uninstalls the Vs Code server on the remote. This command causes the [`interactivelyPickSshHost`](#Interactively-Pick-Ssh-Host) to engage, see below for details on how this picker works. | ||
| - parameters: none | ||
| - returns: none | ||
| - this command is called with the command palette command "Uninstall VS Code Server from Host..." |
There was a problem hiding this comment.
I don't think I full understand how cleanRemoteServer and cleanDevBox differ. From my understanding, it is just that cleanDevBox logs the output of this action, runs showInformationMessage to pop up info and handles the cleaning in a try-catch block which displays an additional message back to the user based on success / failure. I would want to have a clear distinction between the two in this doc so help clarifying would be great.
There was a problem hiding this comment.
The naming isn't great, but cleanRemoteServer only deletes the server bits that were installed, while cleanDevBox deletes everything including remote extensions and user data
I think that nice logging that you noticed should have been added to both
remote-ssh-stable-commands.md
Outdated
| @@ -0,0 +1,45 @@ | |||
| The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will comitt to keeping stable like an API. These commands, now published externally here, will be maintained and changes will not be made without sufficient warning to allow for other dependent extensions to function correctly. | |||
There was a problem hiding this comment.
Don't say that we'll make breaking changes but warn extension authors about it. That conflicts with saying that we are committing to keeping it stable. We shouldn't make breaking changes.
There was a problem hiding this comment.
There is still a typo for commit
This comment was marked as off-topic.
This comment was marked as off-topic.
|
@fanch1122 please create an issue for this bug if you would like assistance |
| @@ -0,0 +1,27 @@ | |||
| The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will comitt to keeping stable like an API. These commands, now published externally here, will be maintained. | |||
There was a problem hiding this comment.
I don't think any of this paragraph of necessary, you can just delete it
|
|
||
| ## Interface Definitions | ||
|
|
||
| ##### IOpenWindowsArgs Definition |
There was a problem hiding this comment.
Why does this go from a level 2 to level 5 markdown header?
Closes #7549 We got this request from an extension developer, in addition to just writing this doc we would have to commit to maintaining these functions. I think this is reasonable given how vital they are to the core functionality of the Remote-SSH extension. If this is carried through, comments should be added alongside the functions and the interface to alert future developers.