Skip to content

Update workspace docs for the new setup flow - #125

Merged
csandanov merged 1 commit into
masterfrom
docs/workspace-setup-updates
Sep 25, 2026
Merged

csandanov merged 1 commit into
masterfrom
docs/workspace-setup-updates

Conversation

@csandanov

@csandanov csandanov commented Sep 25, 2026 •

Copy link
Copy Markdown
Member

The development workspace docs described the old setup screens. They named an "Execution mode" setting and a separate "Workspace checkout" block where you chose the working branch. They also required shared ReadWriteMany storage and an existing cluster, and supported only connected repositories. This update describes the new setup flow, so customers can follow the screens they see.

Merge when the new app form and workspace storage changes are live. Until then the page would describe screens customers don't have yet.

Changes

  • Development workspaces (apps/workspaces.md):
    • "Execution mode" becomes Deployment mode, and "Standard" becomes CI/CD to match the form. The page notes that the API and MCP still call the modes STANDARD and WORKSPACE.
    • Workspaces can run on Wodby Cloud, not only on an existing cluster.
    • The source can be your own repository or a boilerplate cloned into a new repository.
    • The working branch is generated as wodby/workspace-<id>. Sizes are set in the Workspace group under Volumes.
    • A new Storage section explains the default one-node storage (any storage class) and storage services shared across nodes. File-watcher advice, limits, and "what can't change later" are updated to match.
    • The old #workspace-or-standard anchor still works for existing links.
  • Applications (apps/index.md): Step 4 describes the deployment mode. Step 5 mentions the Development workspace section and the Workspace volume group.
  • Environments (apps/environments.md): uses the Deployment mode name.

Validation

  • mkdocs build --strict passes with local plugins. The Markdown-export hook was skipped because its bs4 dependency isn't installed locally, so CI will run it.
  • Checked in the built HTML that #workspace-or-standard, #create-a-workspace, #storage and #deployment-mode exist.

Follow-up

The workspace docs described the old setup: an "Execution mode"
setting, a separate "Workspace checkout" block with a chosen working
branch, shared ReadWriteMany storage, existing clusters only, and
connected repositories only.

They now describe the Deployment mode choice between CI/CD and
Development workspace, workspaces on Wodby Cloud, cloning a
boilerplate into a new repository, the generated wodby/workspace-<id>
branch, the Workspace volume group, and the storage choice. Storage
defaults to one node with any storage class; a storage service shares
files across nodes. The old #workspace-or-standard anchor keeps
working.
@csandanov
csandanov marked this pull request as ready for review September 25, 2026 13:30
@csandanov
csandanov merged commit 434ce66 into master Sep 25, 2026
1 check passed
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