Interactive Web Terminals for the Web IDE: Improvements to user facing docs
Here are some proposed updates to the docs about Web IDE Terminals
In the runner configuration section:
-
There's this note about executors
Not all executors are supported
This note links to the compatibility chart where we can see
Interactive Web terminal
is supported on Kubernetes, Docker and Shell (?) runners. So it's not very explicit that File Sync is only supported on Kubernetes runners.We could add this information to the note in this section or in the warning section at the very beginning:
-
We could be more explicit about the properties that are required for the runner to get the Web IDE Terminal working. This is not very clear at the moment, as the doc reads:
the runner should be configured properly.
While this part is linked to the Runner's advanced configuration page, it's not clear which or if all of the attributes (
session_timeout
,listen_address
,advertise_address
) are required for the Web IDE terminal to work. -
[session_server].session_timeout
should be used where[session_server].terminal_max_retention_time
is mentioned. The description given forterminal_max_retention_time
actually matchessession_timeout
from the Runner docs.
In the Web IDE configuration file section:
- We should ensure the example configuration file contains an
image
. Currently, if a user wants to copy/paste the one we have as the example, there will be an error because the image is not provided there.
Unrelated to any specific section on this page:
- Maybe the document could use a more real life example of project and configuration
❓ Something that could help users get started with the Terminal without having to make all the initial decisions (like where to run the runner, which executor to use, etc).
Bonus:
- The link in Interactive Web Terminals page currently goes into the Web IDE page. We should update it to go to the actual section about the Terminal.