User:Martyav/Deployment

= Improvements to deployment pipeline documentation = Start: 18 April 2019

End: 1 July 2019

Deployment related

 * Category:Deployment on Wikitech
 * Wikitech deployments article
 * How to deploy code
 * How to deploy master branch

Phabricator tickets

 * Update and Improve ToolForge Technical Documentation
 * SRE FY2019 Q3 goal: Increase reach of deployment pipeline
 * TEC3:O6:O:6.1:Q3: Deployment Pipeline Documentation
 * Tracking task for all the TEC3 Q4 SRE serviceops work
 * TEC3:O6:O:6.1:Q4: Deployment Pipeline Documentation
 * "This ticket tracks the work to be done to set up a Jenkins CI + Docker + Kubernetes deployment pipeline for the Stream Intake Service recently named EventGate."

Community
Sarah Rodlund, Toolforge doc improvements

User research
Top viewed wikitech pages search

Writing

 * Wiki technical docs style guide
 * Wiki markup

Statement of work quick look

 * Create a developer portal [1] under wikitech.wikikimedia.org for the deployment pipeline
 * Create a "quick start" guide about creation and introduction of new services in the Deployment Pipeline
 * Improve the Deployment Pipeline “quick start guide” the point where new users of the pipeline are able to create a new service and introduce it to the deployment pipeline
 * Perform a dummy service walkthrough (from a new-user perspective) to find documentation gaps, and address them
 * This may involve helping to create a walk-through/recipe template that can be reused as a standard design for future documentation
 * Populate the portal with documentation about the various Deployment Pipeline components and how they are to be used
 * Improve and organize existing technical documentation following the standards of the Mediawiki technical documentation style guide
 * Coordinate with ongoing reorganization of Wikitech technical documentation to support a cohesive, consistent user experience throughout