Page MenuHomePhabricator

Write setup documentation for setting up TheWikipediaLibrary extension locally
Open, Needs TriagePublic

Description

Extension:TheWikipediaLibrary can be difficult to setup locally as it depends on both Echo and CentralAuth. We don't have good documentation for going through this local setup, which is a prerequisite to our IP masking testing, so let's take the opportunity to write some.

Event Timeline

Hi. I fell down a Wiki rabbit hole and ended inside this tool for the first time. But, as it happens, I've been looking for a project and documentation is my jam! I've been a technical writer for 20+ years, particularly when it comes to creating technical KBs and documentation guides, back to creating Word '97 docs on how to use a SMART+ interface. But I have a concern I wanted to ask about, before volunteering to take this on.

I am not what anyone would call a developer - coding is something I've always wished to be good at, but simply am not. Thus, while I've had a Github account for a bit, it has barely been touched.

But I have worked in IT (Tier 1, Enterprise Security) and software documentation for so long that I know my way around both using advanced browser extensions and documenting browser instructions for even the most computer-illiterate of users. Plus, by nature, I learn new tasks and software very quickly.

Would my skillset probably be sufficient, or would it require significant developer knowledge to create this documentation effectively?

Hi. I fell down a Wiki rabbit hole and ended inside this tool for the first time. But, as it happens, I've been looking for a project and documentation is my jam! I've been a technical writer for 20+ years, particularly when it comes to creating technical KBs and documentation guides, back to creating Word '97 docs on how to use a SMART+ interface. But I have a concern I wanted to ask about, before volunteering to take this on.

I am not what anyone would call a developer - coding is something I've always wished to be good at, but simply am not. Thus, while I've had a Github account for a bit, it has barely been touched.

But I have worked in IT (Tier 1, Enterprise Security) and software documentation for so long that I know my way around both using advanced browser extensions and documenting browser instructions for even the most computer-illiterate of users. Plus, by nature, I learn new tasks and software very quickly.

Would my skillset probably be sufficient, or would it require significant developer knowledge to create this documentation effectively?

Thanks for your interest! I think this task probably isn't the right one for you since it requires downloading and installing MediaWiki and an extension and documenting the technical steps involved.

You can find a bunch of guidance and advice here for how to get started with technical writing for MediaWiki, and there are a bunch of tasks at Documentation :)

The most difficult part of this setup was for CentralAuth, which I documented a while back:
https://www.mediawiki.org/w/index.php?title=MediaWiki-Docker/Extension/CentralAuth

kostajh subscribed.

Seems only tangentially related to Temporary accounts, so untagging that project.