Change Details

We have some documentation for our [[ https://wikitech.wikimedia.org/wiki/Deployment_pipeline | deployment pipeline]], [[https://mediawiki.org/wiki/GitLab | GitLab ]], and the tools used in the pipeline—[[ https://wikitech.wikimedia.org/wiki/Blubber | Blubber ]] and [[ https://gitlab.wikimedia.org/repos/releng/kokkuri | Kokkuri ]]. But this documentation has some issues: 1. It's incomplete—some docs use the [[ https://documentation.divio.com/ | Divio ]] documentation system while some are a few examples 2. It's spread out: Deployment Pipeline and Blubber on Wikitech, GitLab on MediaWiki, and Kokkuri lives in markdown on GitLab 3. Parts are out-dated, like the Deployment Pipeline page My hope is we can improve this: 1. Finish out some of the docs with "TODOs" in them, for example: [[ https://www.mediawiki.org/wiki/GitLab/Hosting_a_project_on_GitLab#Enabling_GitLab_CI_for_a_project | Enabling GitLab CI for a Project ]] 2. Add docs focused on developers achieving specific tasks vs the tools, e.g., migrating your existing simple repository (covering GitLab, Gerrit, and Kokkuri), publishing a docker image from your service (which would cover GitLab, Kokkuri, and Blubber), etc 3. Agree on an information architecture/plan/place to put information (for example, [[ https://www.mediawiki.org/wiki/GitLab/Hosting_a_project_on_GitLab | Hosting a project on GitLab ]] covers publishing docs, but localization updates lives under [[ https://www.mediawiki.org/wiki/GitLab/Localization_updates | a different top-level url ]] OR what should live under "Deployment Pipeline"...maybe nothing at this point :)) == Stakeholders == * Technical Documentation * Release Engineering * <add your name here if you want to be involved> == Project plan == - Kickoff phase [x] Project discovery and initial research [x] Kickoff meeting with members of the Release Engineering team - Research phase [] User research [] First round of SME interviews [] Collection review [x] Create a repository for pipeline testing and experiments [] Formulate a project plan [] Identify candidates for first improvements [] Define long-term goals

We have some documentation for our [[ https://wikitech.wikimedia.org/wiki/Deployment_pipeline | deployment pipeline]], [[https://mediawiki.org/wiki/GitLab | GitLab ]], and the tools used in the pipeline—[[ https://wikitech.wikimedia.org/wiki/Blubber | Blubber ]] and [[ https://gitlab.wikimedia.org/repos/releng/kokkuri | Kokkuri ]]. But this documentation has some issues: 1. It's incomplete—some docs use the [[ https://documentation.divio.com/ | Divio ]] documentation system while some are a few examples 2. It's spread out: Deployment Pipeline and Blubber on Wikitech, GitLab on MediaWiki, and Kokkuri lives in markdown on GitLab 3. Parts are out-dated, like the Deployment Pipeline page My hope is we can improve this: 1. Finish out some of the docs with "TODOs" in them, for example: [[ https://www.mediawiki.org/wiki/GitLab/Hosting_a_project_on_GitLab#Enabling_GitLab_CI_for_a_project | Enabling GitLab CI for a Project ]] 2. Add docs focused on developers achieving specific tasks vs the tools, e.g., migrating your existing simple repository (covering GitLab, Gerrit, and Kokkuri), publishing a docker image from your service (which would cover GitLab, Kokkuri, and Blubber), etc 3. Agree on an information architecture/plan/place to put information (for example, [[ https://www.mediawiki.org/wiki/GitLab/Hosting_a_project_on_GitLab | Hosting a project on GitLab ]] covers publishing docs, but localization updates lives under [[ https://www.mediawiki.org/wiki/GitLab/Localization_updates | a different top-level url ]] OR what should live under "Deployment Pipeline"...maybe nothing at this point :)) == Stakeholders == * Technical Documentation * Release Engineering * <add your name here if you want to be involved> == Project plan == - Kickoff phase [x] Project discovery and initial research [x] Kickoff meeting with members of the Release Engineering team - Research phase [] User research [] First round of SME interviews [] Collection review [x] Create a repository for pipeline testing and experiments [] Formulate a project plan [] Identify candidates for first improvements [] Define long-term goals - Implementation phase [] Create a high-level deployment pipeline overview

We have some documentation for our [[ https://wikitech.wikimedia.org/wiki/Deployment_pipeline | deployment pipeline]], [[https://mediawiki.org/wiki/GitLab | GitLab ]], and the tools used in the pipeline—[[ https://wikitech.wikimedia.org/wiki/Blubber | Blubber ]] and [[ https://gitlab.wikimedia.org/repos/releng/kokkuri | Kokkuri ]]. But this documentation has some issues: 1. It's incomplete—some docs use the [[ https://documentation.divio.com/ | Divio ]] documentation system while some are a few examples 2. It's spread out: Deployment Pipeline and Blubber on Wikitech, GitLab on MediaWiki, and Kokkuri lives in markdown on GitLab 3. Parts are out-dated, like the Deployment Pipeline page My hope is we can improve this: 1. Finish out some of the docs with "TODOs" in them, for example: [[ https://www.mediawiki.org/wiki/GitLab/Hosting_a_project_on_GitLab#Enabling_GitLab_CI_for_a_project | Enabling GitLab CI for a Project ]] 2. Add docs focused on developers achieving specific tasks vs the tools, e.g., migrating your existing simple repository (covering GitLab, Gerrit, and Kokkuri), publishing a docker image from your service (which would cover GitLab, Kokkuri, and Blubber), etc 3. Agree on an information architecture/plan/place to put information (for example, [[ https://www.mediawiki.org/wiki/GitLab/Hosting_a_project_on_GitLab | Hosting a project on GitLab ]] covers publishing docs, but localization updates lives under [[ https://www.mediawiki.org/wiki/GitLab/Localization_updates | a different top-level url ]] OR what should live under "Deployment Pipeline"...maybe nothing at this point :)) == Stakeholders == * Technical Documentation * Release Engineering * <add your name here if you want to be involved> == Project plan == - Kickoff phase [x] Project discovery and initial research [x] Kickoff meeting with members of the Release Engineering team - Research phase [] User research [] First round of SME interviews [] Collection review [x] Create a repository for pipeline testing and experiments [] Formulate a project plan [] Identify candidates for first improvements [] Define long-term goals - Implementation phase [] Create a high-level deployment pipeline overview