Document Web Terminal configuration

added to epic &9169 (closed)

added Category:Remote Development Deliverable backend devopscreate featureaddition frontend groupeditor [DEPRECATED] sectiondev spike typefeature workflowready for development labels

changed title from Document nWeb Terminal configuration to Document Web Terminal configuration

changed the description

assigned to @oregand

@ericschurter

Are we happy to have this documentation added in Iteration 2 as part of the UI offering?

unassigned @oregand

changed epic to &9890 (closed)

@oregand I'm re-visiting this issue and thinking about how and when we need to update the documentation.

As we plan to remove the old Web IDE in 16.0, we should plan to update the documentation for Interactive Web Terminals in the Web IDE at the same time. I don't expect this to be a breaking change for many people, especially since you can accomplish the same task elsewhere in GitLab, but it's a significant enough change that we want to explain what's going on.

My first instinct is to:

Remove everything about this feature except the heading
Update the heading to describe how the new Terminal feature works
Explain how and why it can't be used to interact with a runner (yet)
Link to the configuration documentation for the remote development server

@ericschurter

I am fully supportive of this approach.

@ashrafkhamis

Do you feel comfortable picking this up as a deliverable with the Web IDE GA in this milestone / %16.0 ?

@oregand @ericschurter Thanks for the heads up. Sounds good to me. Happy to take a close look at any MR for this.

Hi @oregand @ericschurter 👋 I see this is scheduled for 15.11. Is the plan here to open an MR and add me as a reviewer?

@ashrafkhamis

I think I will need to pick this up as an MR in the coming days 😄

@oregand Do we still need to expand this section before we can close this issue? The new section covers most of the things @ericschurter mentions above.