Skip to content

docs: add workspace debug mode documentation#3111

Open
snecklifter wants to merge 1 commit into
eclipse-che:mainfrom
snecklifter:docs/debug-workspace-mode
Open

docs: add workspace debug mode documentation#3111
snecklifter wants to merge 1 commit into
eclipse-che:mainfrom
snecklifter:docs/debug-workspace-mode

Conversation

@snecklifter
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new procedure page debugging-a-workspace.adoc documenting how to use debug mode for diagnosing workspace startup failures
  • Covers the dashboard UI actions ("Open in Debug mode" for stopped workspaces, "Restart in Debug mode" for running workspaces)
  • Documents how to inspect postStart logs at /tmp/poststart-stderr.txt and /tmp/poststart-stdout.txt
  • Includes a warning that manually patching the controller.devfile.io/debug-start annotation is overwritten by the dashboard
  • Adds the page to the troubleshooting navigation and assembly page

Test plan

  • Verify AsciiDoc renders correctly in Antora build
  • Verify all cross-references resolve (nav.adoc, troubleshooting-che.adoc)
  • Verify attribute substitutions ({prod-short}, {orch-cli}, etc.) work correctly

Related

🤖 Generated with Claude Code

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 28, 2026

Click here to review and test in web IDE: Contribute

Add a new procedure page documenting how to use debug mode for
diagnosing workspace startup failures. Covers the dashboard UI
actions ("Open in Debug mode" and "Restart in Debug mode"), log
inspection, and clarifies that manual annotation patching is
overwritten by the dashboard.

Related: eclipse-che/che-dashboard (Restart in Debug mode feature)

Signed-off-by: Chris Brown <snecklifter@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@snecklifter snecklifter force-pushed the docs/debug-workspace-mode branch from 7f9a4ec to 11eb2f3 Compare May 28, 2026 12:07
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.

Document workspace debug mode for diagnosing startup failures

1 participant