Skip to content

Add remoting docs #1162

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 6 commits into from
Jan 25, 2018
Merged

Conversation

TylerLeonhardt
Copy link
Member

@TylerLeonhardt TylerLeonhardt commented Jan 12, 2018

These are some docs to help folks understand how to use VSCode to remote edit/debug scripts!

Hoping this is in the right place.

https://github.com/tylerl0706/vscode-powershell/blob/remoting-doc/docs/remoting.md

Copy link
Contributor

@daviwil daviwil left a comment

Choose a reason for hiding this comment

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

Thanks for putting this together, it's really helpful! My main concern is checking in a bunch of images to the repo since it bulks up the size a lot. Is it possible that we could get a section for PowerShell extension docs on the official PowerShell docs site? I had talked to Zach about this in the past but I dunno what came of it.

docs/remoting.md Outdated
![psedit the test.ps1 file](Assets/pseditremote.png)
2. Edit the file/set breakpoints
![edit and set breakpoints](Assets/addbreakpointremote.png)
3. Start debugging the remote file
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd mention the use of F5 again here just in case the skipped the previous section

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

@TylerLeonhardt
Copy link
Member Author

@daviwil I had talked to @SteveL-MSFT about putting some docs here and also posting a blog post - but using the PowerShell docs site might be a good alternative to putting them in the repo.

Either that - or we can throw the images somewhere else (imgur or somewhere) and link them from there though idk if it's ok.

@daviwil
Copy link
Contributor

daviwil commented Jan 12, 2018

One cheeky thing that I've done in the past is paste the images into a GitHub issue (or PR) and then link to the CDN images that get created... See CHANGELOG.md for examples of this mischief ;)

@TylerLeonhardt
Copy link
Member Author

@daviwil no more images 😄

Lets call PowerShell Docs out of scope for this PR.

@TylerLeonhardt
Copy link
Member Author

I'm going to have to change these when Open-EditorFile gets released... you resolve some, you open some I guess 😄

@TylerLeonhardt
Copy link
Member Author

FYI, I did a slight update that talks about Open-EditorFile.

@TylerLeonhardt TylerLeonhardt merged commit cb1515f into PowerShell:master Jan 25, 2018
@TylerLeonhardt TylerLeonhardt deleted the remoting-doc branch January 25, 2018 00:46
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.

2 participants