-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Add documentation for exec websocket #9679
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I read through it and it makes sense to me!
The thing that wasn't clear to me was if the response frames should be appended to output or if they represent the full buffer.
I know things like top
work but it wasn't clear what the mechanics are for line clearing. Maybe those are just xterm instructions that come through the stdout
messages?
# basic application-level heartbeat | ||
{} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: extra newline (I tried to get rid of it with a suggestion but it didn't seem to work).
This is correct! Do you think this is worth mentioning? |
I don't think it would hurt to add it. |
This prevents having to scroll horizontally.
👍 I added an example request and response to provide some explanation of the content of frames, thoughts? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it! That sample gives just enough guidance on what to expect while also introducing some vocab someone can do further research on.
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
This is a continuation of #6604. You can preview it in situ here.