This repository serves as a static-site generator for docs.webplatform.org, anything related generating HTML.
No content should be stored in this repo, but only what it takes to generate the docs pages. The content itself is pulled in this workspace as git submodule so we can compile the static HTML files.
To get the docs pages, refer to the following git repositories.
| Directory | Submodule | Note |
|---|---|---|
| src/ | webplatform/docs | The main docs pages |
| src/Meta/ | webplatform/docs-meta | Archived content that needed to be moved during mass imports. We kept them there to cherry-pick and merge into the main content section. Was accessible under the URL docs.webplatform.org/wiki/Meta:... |
| src/WPD/ | webplatform/docs-wpd | Community and notes section. Was accessible under the URL docs.webplatform.org/wiki/WPD:... |
What’s left to do prior to use this project to replace WebPlatform Docs MediaWiki instance.
Roughly all issues described in webplatform/mediawiki-conversion.
- Convert MediaWiki history into Git source-controlled text files
- Pass a filter to every page to make it suitable for a static site generator
- Reproduce directory listing for pages without content
- Make sure all uploads are visible from generated site
-
Reproduce search functionality(at least leave metadata to help making the feature) - Ensure ALL URLs are kept with appropriate redirects (almost there! needs testing)
- Get list of views the static site won’t be reproducing anymore so we can create appropriate "410 Gone" response #11
To learn how the conversion was done, take a look at the MediaWiki conversion project utility and the content converter library.