# Wikibase Suite (WBS) WBS is a DevOps product designed to simplify the deployment and maintenance of a customizable installation and configuration of MediaWiki with the Wikibase extension. It includes required and commonly used companion services such as WDQS and QuickStatements. The intended audience for WBS includes those who require a Wikibase instance not served by Wikibase Cloud. The product consists of two related deliverables: **WBS Docker Images** Standardized, tested, and configurable Docker Image distributions of common Wikibase services (WBS Docker Images). - Wikibase (wikibase/wikibase) A configured MediaWiki instance packaged with the Wikibase extension - Wikibase Bundle (wikibase/wikibase-bundle) A configured MediaWiki instance packaged with Wikibase and other related and commonly used extensions - Wikidata Query Service (wikibase/wdqs, wikibase/wdqs-proxy, and wikibase/wdqs-frontend) - QuickStatements (wikibase/quickstatements) - Elasticsearch (wikibase/elasticsearch) **WBS Deployment Kit** All of the above services orchestrated to run together along with related documentation and guidance for running those services in a production environment. ## Required Skills To effectively utilize the WBS Docker Images and Example, the following skills are required: - Intermediate knowledge of general DevOps (Linux/VPS administration, proxy management, etc) - Intermediate knowledge Docker and Docker Compose - Intermediate knowledge of MediaWiki and Wikibase configuration ## Support (DRAFT) The WBS team is dedicated to supporting efforts to openly share linked data and is available for support through the following channels: 1. Bug reports: https://phabricator.wikimedia.org/maniphest/task/edit/form/43/ 2. Feature Requests: https://phabricator.wikimedia.org/maniphest/task/edit/form/43/ 3. Code-level issues and Pull Requests: https://github.com/wmde/wikibase-release-pipeline --- # User Stories **Adoption** As a devops user evaluating WBS who has decided to try Wikibase to represent my data, I can effectively evaluate WBS as an option. As a devops user evaluating WBS, I want to be able to configure WBS to meet the specific needs of my production environment. **Operation** As a devops user running a WBS instance in production, I want robust documentation and support resources for troubleshooting common issues and optimizing my use of WBS. As a devops user running a WBS instance in production, I want my installation and data to be secure. As a devops user running a WBS instance in production, I want to be able to update to new versions of WBS services. As a devops user running a WBS instance in production, I want to be able to easily backup and restore my data and configuration. --- # Planning > UX Metrics Key: > 1: No way to do it > 2: Possible but hacky (still pretty broken) > 3: “Good enough” works but misses key functionality > 4: All key functionality available > 5: Includes quality of life features that expand functionality or improve ux **Adoption** *Target 3 / Current 2* As a devops user who has decided to try Wikibase to represent my data, I can effectively evaluate WBS as an option. As a devops user evaluating WBS, I want to be able to configure WBS to meet the specific needs of my production environment. **Operation** *Target 3 / Current 2* As a devops user running a WBS instance in production, I want robust documentation and support resources for troubleshooting common issues and optimizing my use of WBS. As a devops user running a WBS instance in production, I want to be able to easily and reliably upgrade to new versions of WBS services. ## Export of Current Phab tickets (as of 24.02), with groupings by Adoption and Operation: https://docs.google.com/spreadsheets/d/1HRbHeLYEHdSOrSakKGLcGjUBDbogIUlP7_X1-nfrRyE/edit#gid=210075339