Skip to content
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

Quick start doc in README #1059

Merged
merged 5 commits into from Oct 9, 2019

Conversation

TylerLeonhardt
Copy link
Member

@TylerLeonhardt TylerLeonhardt commented Oct 4, 2019

fixes #1057

Note, this is not exhaustive but I wanted to write something down to at least give folks a place to start.

In theory a more exhaustive doc should be elsewhere (like on docs.microsoft.com) but this will do for now.

Copy link
Collaborator

@rjmholt rjmholt left a comment

Choose a reason for hiding this comment

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

This is very good information.

I don't want to prescribe too much in terms of style or tone, but could if you like.

Some things it might be worth mentioning:

  • Why Stdio doesn't support the Integrated Console
  • What startup looks like and what the timing is between client and server (so people don't think the script has hung)
  • Security considerations for clients using named pipes
  • How shutdown works and the lifetime of the server compared to the client
  • What we consider to be stable and what clients can depend on (messages vs linking)
  • Why debugging with PowerShell is a bit different (i.e. happens in the same process)

@TylerLeonhardt
Copy link
Member Author

I agree with what you're saying but I think a lot of what you're suggesting should be in a more exhaustive doc instead of a quick start that this is trying to be.

@TylerLeonhardt
Copy link
Member Author

TylerLeonhardt commented Oct 7, 2019

Why Stdio doesn't support the Integrated Console

Added

What startup looks like and what the timing is between client and server (so people don't think the script has hung)

Added

Security considerations for clients using named pipes

Should be in a different doc

How shutdown works and the lifetime of the server compared to the client

Should be in a different doc

What we consider to be stable and what clients can depend on (messages vs linking)

Added

Why debugging with PowerShell is a bit different (i.e. happens in the same process)

Added

@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment from SteveL-MSFT Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
@PowerShell PowerShell deleted a comment Oct 7, 2019
README.md Outdated Show resolved Hide resolved
Co-Authored-By: Robert Holt <rjmholt@gmail.com>
@TylerLeonhardt TylerLeonhardt merged commit 654540a into PowerShell:master Oct 9, 2019
@TylerLeonhardt TylerLeonhardt deleted the start-docs branch October 9, 2019 00:45
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.

How to run ?
2 participants