Skip to content

Improve user facing docs for Web IDE Interactive Terminals

Amparo Luna requested to merge 214881-al-web-ide-terminal-docs into master

What does this MR do?

This MR updates Web IDE interactive terminals documentation:

  • Adds more details to the session_server configuration in the runner section.
  • Replaces usage of [session_server].terminal_max_retention_time with [session_server].session_timeout as the current description for terminal_max_retention_time actually matches session_timeout from the Runner docs.
  • Adds a note about File Sync and the Kubernetes runner.
  • Adds image property to the example Web IDE configuration file.
  • Bonus 1: Update link to the Web IDE page with the anchor.
  • Bonus 2: Remove the ultimate only now that Web IDE is in Core.

Related issues

Resolves #214881 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports