Page MenuHomePhabricator

Improve documentation on Docker-based development environments for new developers
Open, NormalPublic

Description

Per conversation in the Docker SIG kickoff meeting, there's some agreement that documentation on environments for new developers (Docker-based and otherwise) is fragmented at the moment and there's not necessarily a clear funnel / entry point.

A handful of us met and on 2019-03-04. We identified How to become a MediaWiki hacker as a good place to do some work.

As suggested by @egardner I've created Docker/SIG/Documentation as a scratch space for roughing out some notes and docs before we start hacking on existing pages too aggressively.

Event Timeline

brennen created this task.Mar 5 2019, 12:36 AM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
srodlund added a comment.EditedMar 15 2019, 6:37 PM

@brennen After you feel you have a solid plan in place for improving the Docker docs or have identified some specific places for improvement, let's think about how to turn some of the work into microtasks to bring to hack-a-thons and write-a-thons. We have a couple upcoming, and it would be great to have some work to share with attendees.

Here is a running list:

https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons?action=edit&section=3

You may have already seen this resource, as well. We have a style guide for documentation projects to help keep things consistent: https://www.mediawiki.org/wiki/Documentation/Style_guide

@srodlund Thanks! We've let this drift a bit since I filed this task, but hopefully will get some momentum on it soon.

Agreed – since we last chatted about this I've spent a lot of time in the MW Docker Dev environment and may finally be able to contribute some useful information.

greg triaged this task as Normal priority.May 9 2019, 3:51 PM