Add Documentation around setting VSCode and Positron Session Timeouts
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
Description
We should add documentation to the Workbench chart around setting VSCode and Positron session timeouts to prevent VSCode and Positron session pods from running indefinitely. These options are not set by default (in either the Helm charts or in Workbench itself) so it's important to document how to set these features and also our recommendations for doing so.
The setting to use is session-timeout-kill-hours in both positron.conf and vscode.conf.
Reference documentation
- https://docs.posit.co/ide/server-pro/admin/vscode_sessions/configuration.html
- https://docs.posit.co/ide/server-pro/admin/positron_sessions/configuration.html
- https://docs.posit.co/ide/server-pro/user/vs-code/guide/session-timeout.html
- https://docs.posit.co/ide/server-pro/user/positron/guide/session-timeout.html
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the four linked VSCode and Positron session-timeout references, then locate the Workbench chart documentation. Document how to set session-timeout-kill-hours in both positron.conf and vscode.conf, including recommendations for preventing session pods from running indefinitely.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100