Difference between revisions of "Wiki export"

Latest revision as of 11:56, 17 November 2021

In light of "Bug 577153 - Shutdown the Foundations wiki instance", here is a list of possible approaches to extract content from wiki.eclipse.org and store it in a different format and/or somewhere else.

Export wiki pages to Markdown format

Mikael tested the following (quoted from Bug 577153 comment 9:

• Export the pages you want to convert from https://wiki.eclipse.org/Special:Export, save the file to /tmp/wikiexport (or somewhere else, but adjust below accordingly) then

docker run -it --rm --entrypoint -v /tmp/wikiexport:/wikiexport /bin/bash php:7
curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
apt-get update && apt-get install -y git vim pandoc
git clone https://github.com/outofcontrol/mediawiki-to-gfm.git
cd mediawiki-to-gfm
composer update --no-dev
./convert.php --filename=/wikiexport/Eclipsepedia-<timestamp>.xml --output=/wikiexport/markdown/

One nice thing is that you can export multiple pages at once, and they will all be converted at once.

You can see the raw results in of the conversion of https://wiki.eclipse.org/Jenkins to https://github.com/eclipse-cbi/jiro/blob/userdoc/USER_DOC.md

Caveats

• images need to be extracted separately
• creates ''' instead of ** for bold text
• does not replace brackets <> in code-sections with &lt; and &gt;
• skips "note/important/etc" boxes

Export wiki pages to GitHub wiki pages directly (using MediaWiki format)

1. Go to wiki page that should be exported and click on "Edit"
2. Copy Wikitext
3. Go to target GitHub wiki page and paste Wikitext
4. Set "Edit mode" to "MediaWiki"

Caveats

• needs to be done manually for each page
• images need to be extracted separately
• Wiki online editor toolbar is not supported in "MediaWiki" Edit mode
• GitHub wiki pages can not be indexed by search engines at the moment (indexing will probably return soon)
  • => https://github.com/github/feedback/discussions/4992#discussioncomment-1448177
• Restrictions for MediaWiki syntax support
  • => https://docs.github.com/en/communities/documenting-your-project-with-wikis/editing-wiki-content
• no support for "note/important/etc" boxes