Page MenuHomePhabricator

[Self-Hosting] Documentation Deploy Setup Tool
Open, Needs TriagePublic

Description

Context
We are building a UI-based setup tool for Wikibase Suite Deploy. This tool will complement the current .env configuration process. We need to understand what documentation this tool requires and how it fits into our existing docs structure before development progresses further.

Related work:
https://phabricator.wikimedia.org/T418841
https://phabricator.wikimedia.org/T399695

Goal
Investigate what documentation is needed for the new UI-based setup tool and recommend where it should live within our existing documentation landscape.

Questions to be answered:

  • What documentation is needed?
  • What docs do users need before they reach the wizard? (server requirements, DNS setup, Docker, etc.)
  • Where should this documentation live?
  • How does this relate to existing documentation?

AC

  • Decision about the best way to provide an installation guide to users and where to place it (Github, website, ...)
  • Written recommendation document shared with PM and engineering
  • Recommendation discussed in team sync
  • Decision logged and next steps identified as tasks