User:APaskulin (WMF)/Content Review
Map[edit]
Knowledge management platform
- MediaWiki core
- Extensions for MediaWiki
- User scripts and gadgets
Free knowledge projects
- Websites
- Underlying data
- Communities
Developer tools
- Free knowledge APIs
- Public datasets
- Technical community
Sites[edit]
- Meta-Wiki https://meta.wikimedia.org
- Coordination, documentation, planning, and analysis for the Wikimedia Foundation's projects and related projects
- MediaWiki: https://www.mediawiki.org
- Documentation project for MediaWiki https://en.wikipedia.org/wiki/MediaWiki
- Mediawiki wiki dashboard: https://wikimedia.biterg.io/app/kibana#/dashboard/Mediawiki?_g=()
- Technical and project docs for a range of Wikimedia projects
- "MediaWiki.org is not intended for Wikimedia-specific technical documentation"
- Wikitech docs: https://wikitech.wikimedia.org/wiki/Portal:Wikitech
- Documentation related to the technical projects and infrastructure maintained by the Wikimedia Foundation
- "The Wikimedia technical infrastructure wiki"
- How we use software and how it's configured
- Wikimedia docs home: https://doc.wikimedia.org/
- Research site: https://research.wikimedia.org
- Static site
- Doesn't include links to data
Entry points[edit]
- https://wikimediafoundation.org/technology/
- "Developers" link in the footer of enwiki links to https://www.mediawiki.org/wiki/How_to_contribute
- https://meta.wikimedia.org/wiki/Tech portal split between Meta and mediawiki.org
MediaWiki[edit]
- Release notes
- Pre-release notes in Gerrit: https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/core/+/master/RELEASE-NOTES-1.34
- Mediawiki.org release notes: https://www.mediawiki.org/wiki/MediaWiki_1.33
- Commit log: https://www.mediawiki.org/wiki/MediaWiki_1.33/wmf.25
- Recent changes: https://www.mediawiki.org/wiki/Special:RecentChanges?hidebots=1&translations=filter&hidecategorization=1&hideWikibase=1&limit=50&days=7&urlversion=2
- https://www.mediawiki.org/wiki/Category:Manual
- Search extension: https://www.mediawiki.org/wiki/Help:CirrusSearch
- Customizing search results with boost templates: https://www.mediawiki.org/wiki/Help:CirrusSearch#Boost-templates
- Community pages
- Translation flow: https://www.mediawiki.org/wiki/Special:Translate?group=%21additions&language=de&filter=%21translated&action=translate
- Architecture: https://www.mediawiki.org/wiki/Manual:MediaWiki_architecture
MediaWiki Action API[edit]
- https://www.mediawiki.org/wiki/Category:MediaWiki_action_API
- https://www.mediawiki.org/wiki/API:Improving_technical_documentation
- Feedback gadget: https://wikitech.wikimedia.org/wiki/MediaWiki:Gadget-userfeedback.js
- Tabbed windows gadget: https://www.mediawiki.org/wiki/User:Jayprakash12345/tabbedWindow.js
- Related task: https://phabricator.wikimedia.org/T228920
Wikitext[edit]
Extensions[edit]
- https://www.mediawiki.org/wiki/Best_practices_for_extensions
- MUST/SHALL/SHOULD style doc, marked as a draft
- Based on https://www.mediawiki.org/wiki/Wikimedia_Technical_Committee/Extension_point_guidelines
- See particularly https://www.mediawiki.org/wiki/Best_practices_for_extensions#Documentation
- Best practices specific guidance for content: https://en.wikipedia.org/wiki/User:Risker/Risker%27s_checklist_for_content-creation_extensions
- All extension pages: https://www.mediawiki.org/wiki/Special:AllPages/Extension:
- All extension help pages: https://www.mediawiki.org/wiki/Special:AllPages/Help:Extension:
- Linked to from manual landing and dev landing: https://www.mediawiki.org/wiki/Manual:Developing_extensions
- Marked as outdated
- https://www.mediawiki.org/wiki/Manual:Extensions
- Not linked to from main landing pages
- https://www.mediawiki.org/wiki/Extensions_FAQ
- Examples
- Boiler plate: https://www.mediawiki.org/wiki/Extension:BoilerPlate
- BoilerPlate should show latest coding practices https://phabricator.wikimedia.org/T97105
- Example: https://www.mediawiki.org/wiki/Extension:Example
- Review and update the Examples extension https://phabricator.wikimedia.org/T156568
- https://github.com/JonasGroeger/cookiecutter-mediawiki-extension
- Boiler plate: https://www.mediawiki.org/wiki/Extension:BoilerPlate
- API extension interface: https://www.mediawiki.org/wiki/API:Extensions
- Example extension doc: https://www.mediawiki.org/wiki/Help:Extension:MassMessage
- Community project: https://www.mediawiki.org/wiki/Project:WikiProject_Extensions/Projects#Documentation
RESTBase APIs[edit]
- Project page: https://www.mediawiki.org/wiki/RESTBase
- API page: https://www.mediawiki.org/wiki/REST_API
- https://www.mediawiki.org/wiki/API_versioning
- OpenAPI spec served at https://project.url/api/rest_v1/
- Docs in GitHub: https://github.com/wikimedia/restbase/tree/master/doc
Tools[edit]
- https://en.wikipedia.org/wiki/Help:Creating_a_bot (and other languages)
- https://en.wikipedia.org/wiki/Wikipedia:Bots (and other languages)
- Tools definition: https://meta.wikimedia.org/wiki/Tools
Hub indexes[edit]
- https://www.mediawiki.org/wiki/User:Quiddity_(WMF)/Hubs_and_docs
- https://office.wikimedia.org/wiki/User:Quiddity_(WMF)/Documentation_work_hub
- https://www.mediawiki.org/wiki/User:AKlapper_(WMF)/Talks#Overview_to_Wikimedia_Tech
- https://phabricator.wikimedia.org/T169599
Analytics[edit]
Objectives[edit]
Documentation policies[edit]
Example pages[edit]
Challenges[edit]
- Readability of Vector for documentation: Due to the density of information in technical documentation and the increased tendency of readers to skim documentation, Vector can be challenging for people not already familiar with the Wikimedia movement.
- Multi-wiki system: The idea of multiple, interconnected documentation wikis is tough to grasp, both visually and logistically.
Opportunities[edit]
- Repeatable process for launching and maintaining Wikimedia-related static sites for documentation
- Invest in quality-of-life improvements for wiki docs maintainers