Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: clarify workspace scheduling priority and autostop requirement behavior #18447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

blink-so[bot]
Copy link
Contributor

@blink-so blink-so bot commented Jun 19, 2025

Summary

This PR improves documentation clarity around workspace scheduling priority, specifically addressing confusion about how autostop requirements interact with user-configured autostop settings.

Changes

Template Admin Documentation (docs/admin/templates/managing-templates/schedule.md)

  • Added "Priority and interaction with user settings" section explaining precedence rules
  • Included specific scenarios showing when requirements vs user settings apply
  • Clarified that autostop requirements always take precedence over user settings

User Guide Documentation (docs/user-guides/workspace-scheduling.md)

  • Added note in autostop section about potential requirement overrides
  • Added comprehensive FAQ section addressing common scheduling questions
  • Explained when workspaces will shut down with different configuration combinations

Problem Solved

Users were confused about scheduling behavior in scenarios like:

  • Template has "Days with required stop" = Daily
  • Template allows user customization
  • User sets workspace autostop = 7 days

Result: Workspace still shuts down daily during quiet hours (requirement takes precedence)

Testing

  • Reviewed existing documentation structure
  • Ensured consistent formatting and style
  • Verified all scenarios match actual code behavior in /coderd/schedule/autostop.go

Addresses user confusion reported in Slack about scheduling priority behavior.

…behavior

- Add priority section to template schedule docs explaining how autostop requirements take precedence over user settings
- Add note to user guide about autostop requirement overrides
- Add FAQ section addressing common scheduling confusion
- Include specific scenarios showing when requirements vs user settings apply

Fixes confusion around when workspaces shut down when both template autostop requirements and user autostop settings are configured.

Co-authored-by: matifali <[email protected]>
Copy link
Contributor Author

blink-so bot commented Jun 19, 2025

@stirby Could you please review this PR? This addresses the scheduling priority confusion that was discussed in Slack, specifically clarifying how autostop requirements interact with user-configured autostop settings.

The documentation now clearly explains that:

  • Autostop requirements always take precedence over user settings
  • Users can set shorter durations but cannot exceed the requirement
  • The earliest deadline wins

This should help reduce customer confusion about when workspaces will actually shut down.

blink-so bot and others added 2 commits June 19, 2025 09:24
Fixes lint failure by removing trailing whitespace that was causing the CI check to fail.

Co-authored-by: matifali <[email protected]>
The markdown linter expects blank lines after scenario headings before list items.
This fixes the CI lint failure by conforming to the expected markdown format.

Co-authored-by: matifali <[email protected]>
@matifali matifali self-assigned this Jun 19, 2025
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.

1 participant