Page MenuHomePhabricator

[Deploy] Correct and better organize docs
Closed, ResolvedPublic

Description

Description

The current WBS Deploy documentation is incomplete or misleading in several important areas for users installing, resetting, or upgrading an instance. Several of these changes are in response to the most recent round of manual installation user testing, where important existing guidance was missed or misunderstood.

We should revise the documentation so the main operational workflows are accurate, easier to follow, and better organized.

Key areas to address:

  • Reset procedure: Properly document the reset workflow, including when a reset is required. This should cover failed initial installs, changes to .env values after first start, and major upgrades where the stack needs to run setup again.
  • Local installation is not supported: Highlight more clearly that WBS Deploy is not currently supported for local installation on a laptop or desktop, and that the documented setup path expects a VPS or server with public DNS.
  • Initial .env configuration: Correctly describe .env values as setup values rather than general runtime configuration. Document which values users need to set, which defaults may be kept, and that most .env changes after first start require a reset. METADATA_CALLBACK should be documented as the exception.
  • Image README cleanup: Replace the full Docker Compose examples in individual image READMEs with links to the WBS Deploy Docker Compose configuration, so integrated usage examples are maintained in one place instead of duplicated across image documentation.
  • General cleanup: Move deploy operational documentation into a deploy/docs directory, keep the root deploy README focused on the main installation path, remove or merge overly small/duplicative docs, fix broken links, and correct other inaccurate or confusing documentation discovered during review.

Definition of Done

  • Resetting an instance is documented as a clear, standalone procedure.
  • Documentation explains how reset relates to failed installs, changed .env values, and major upgrades.
  • .env setup values are documented accurately, including defaults and the METADATA_CALLBACK exception.
  • The install guide more clearly highlights that local installation is not supported.
  • Deploy operational docs are moved into a coherent deploy/docs structure.
  • Duplicated or obsolete deploy docs are removed or merged.
  • Individual image READMEs no longer duplicate full integrated Docker Compose examples and instead link to the WBS Deploy Docker Compose configuration.
  • Known inaccurate instructions are corrected, including Docker Compose override behavior and extension configuration guidance.
  • Local documentation links are checked and fixed.

Event Timeline

lojo_wmde renamed this task from [Docs] Update documentaion for major upgrades and reset to [Deploy] Correct and better organize setup, reset, and configuration docs.May 7 2026, 9:58 AM
lojo_wmde updated the task description. (Show Details)
lojo_wmde updated the task description. (Show Details)
lojo_wmde updated the task description. (Show Details)
lojo_wmde updated the task description. (Show Details)
lojo_wmde updated the task description. (Show Details)
lojo_wmde updated the task description. (Show Details)
lojo_wmde renamed this task from [Deploy] Correct and better organize setup, reset, and configuration docs to [Deploy] Correct and better organize docs.May 7 2026, 11:05 AM