You are browsing a read-only backup copy of Wikitech. The primary site can be found at wikitech.wikimedia.org
doc.wikimedia.org
doc.wikimedia.org is the publication target for auto-generated software documentation.
Service
Currently hosted on doc1001 (through misc-web-lb). Formerly on gallium.
Architecture
Landing pages
The navigational structure and page layout is server-side generated by simple PHP script. This provides navigation header, footer, and page layout. The main content of each page comes from either an HTML file, YAML file, or PHP function that produces a directory index.
The root page lists project for which documentation is open, one can see it as a catalogue of some of our open source product. Items can be added by editing the file org/wikimedia/doc/opensource.yaml. See the repository README.md for additional details and to test your change locally.
Examples of URLs in scope:
- https://doc.wikimedia.org/
- https://doc.wikimedia.org/cover/ (domain-specific directory index).
- https://doc.wikimedia.org/unicodejs/ (generic directory index for software versions).
- https://doc.wikimedia.org/mediawiki-core/1.34.0/ (generic directory index for different outputs for a given software version).
- https://doc.wikimedia.org/mediawiki-libs-Timestamp/ (to produce a redirect to the only subdirectory).
Microsites
These landing pages link out to microsites with API documentation, demos, and coverage reports. Each of these is entirely standalone and statically generated. The are published by post-merge CI jobs into the /srv/doc/ directory outside the landing pages' document root.
To learn how we (securely) transfer these sites from CI to the doc.wikimedia.org server, see Continuous integration/Documentation generation on mediawiki.org.
Examples of URLs in scope:
- https://doc.wikimedia.org/mediawiki-core/1.33.0/php/ (Doxygen output).
- https://doc.wikimedia.org/mediawiki-core/1.33.0/php/search.php?query=load.php (Doxygen output supports search via PHP script).
- https://doc.wikimedia.org/unicodejs/v13.0.3/ (JSDuck output).
- https://doc.wikimedia.org/oojs/v6.0.0/ (JSDoc3 output).
- https://doc.wikimedia.org/mw-tools-scap/ (Sphinx for Python output).
- https://doc.wikimedia.org/cover/mediawiki-libs-Minify/ (PHPUnit test coverage).
- https://doc.wikimedia.org/cover/unicodejs/ (Istanbul.JS test coverage).