[Labs-l] Plan for improving Tool Labs docs next week

Sumana Harihareswara sumanah at wikimedia.org
Fri Aug 16 22:23:24 UTC 2013


At Wikimania, I sat in on one of the three sessions about Tool Labs
(thank you, Coren, Ryan, and Silke for doing those!), and asked about
barriers to switching.  Aside from the storage issues, it sounds like
people get lost in obsolete documentation.  So I spoke with Kirsten
today and we've come up with a plan: what do you think?

1. Between now and Tuesday 20 August, Kirsten will improve
https://www.mediawiki.org/wiki/User:Kmenger/ToolLabsGuide (the product
of the July doc sprint) and fill in Pywikipedia and Git/Gerrit stuff.
You are welcome to improve it right now to correct errors.
2. On Tuesday, we'll replace the Tool Labs help page(s) on
wikitech.wikimedia.org with the new Tool Labs Guide.
3. A couple of days after that, we'll publicize the new guide via IRC,
social media, labs-l, maybe blog.wikimedia.org, various WMF
wikis/village pumps/the weekly Tech News/etc.
4. Hopefully on Friday of next week, I'll hold an IRC sprint to consult
with Ryan, Silke, and Coren and start to go through other current Tool
Labs-related documentation to update/redirect/obsolete everything.
Anyone who wants to can get started with the updating right now, of
course.  See the list below and suggestions for what to do with each
page -- thanks for compiling this, Kirsten!

Does this sound good?  I shall read silence as consent. :-)
-- 
Sumana Harihareswara
Engineering Community Manager
Wikimedia Foundation



* https://wikitech.wikimedia.org/wiki/Nova_Resource:Tools/Help
[UPDATE/REPLACE WITH NEW, EXPANDED GUIDE OUTLINED ABOVE]
* https://wikitech.wikimedia.org/wiki/Nova_Resource:Tools [UPDATE WITH
HIGH-LEVEL OVERVIEW/INFO ABOUT CREATING ACCOUNT]
** Sources for expansion:
http://www.mediawiki.org/wiki/File:Tool_Labs_presentation_(Hackaton_2013).pdf
* https://wikitech.wikimedia.org/wiki/Main_Page [UPDATE:  Under Labs/add
note about Tool Labs and add link to Tools project and Tool Labs guide]
* https://wikitech.wikimedia.org/wiki/Help:Terminology [UPDATE with
additional terms--Tool Labs, Toolsbeta project, Tools project, grid,
cluster... other terms?]
* http://tools.wmflabs.org/ [UPDATE to clarify what these links are
(e.g. "Request access to Tool Labs"; add additional context at top of
page to explain what is on page]
* https://www.mediawiki.org/wiki/Wikimedia_Labs [Appears
current/recently updated]
* https://www.mediawiki.org/wiki/Developer_access [UPDATE with context--
what does 'developer access' mean exactly? ]
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Needed_Toolserver_features
[update]
* https://wikitech.wikimedia.org/wiki/Help:Getting_Started [Appears current]
* https://wikitech.wikimedia.org/wiki/Nova_Resource:Toolsbeta [UPDATE
with more info about Toolsbeta and how to get access]
*
https://wikitech.wikimedia.org/wiki/Help:Shared_storage#Project_storage
[UPDATE: there's a TODO in the page]
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Migration_of_Toolserver_tools
[Update: replace 'bot' with 'toolsbeta'/also add content
generated/organized in sprint]
* https://www.mediawiki.org/wiki/Wikimedia_Labs/TODO [Appears current]
* http://www.mediawiki.org/wiki/Toolserver/List_of_Tools [Appears current]
* http://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Design [Appears
current]
* https://wikitech.wikimedia.org/wiki/Help:Shared_storage [appears current]
* https://www.mediawiki.org/wiki/Special:PrefixIndex/Wikimedia_Labs/:
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Authentication_improvement_project
[Appears current]
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Instance_creation_improvement_project
[Appears relatively current]
* https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/FAQ [recently
updated, but would love to redirect this to guide/combine info there]
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Create_shared_sql_service_for_all_projects
(last updated jan 2012) Redirect to roadmap:
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Roadmap_en
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Per-project_saltstack_remote_execution
(last update june 2012) Redirect to roadmap:
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Roadmap_en
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Shared_home_directories_per_project
 (last update dec 2011) Redirect to roadmap:
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Roadmap_en
* https://www.mediawiki.org/wiki/Wikimedia_Labs/TODO (Appears current)
* https://www.mediawiki.org/wiki/Wikimedia_Labs/Things_to_fix_in_beta
(Last updated June 2012) Redirect to roadmap:
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Roadmap_en
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/List_of_Toolserver_Tools/tool
[Appears current]
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Log_bot_for_wikimedia-labs_channel
(last update Dec 2011) Redirect
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Roadmap_en
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Nagios_management_without_exported_puppet_resources
(last update Dec 2011) Redirect to roadmap:
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Roadmap_en
* https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Roadmap_en
[Update/to replace 'bots' with 'toolsbeta' to avoid confusion]
* https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Rules [Update
with rules]
* https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs [Update
overview at top of page]
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Reverse_proxy_for_web_services
[last update march 2012/redirect to roadmap]
* https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/Design
(appears current)
*
https://www.mediawiki.org/wiki/Wikimedia_Labs/Tool_Labs/List_of_Toolserver_Tools
[appears current]




More information about the Labs-l mailing list