| ... | ... | @@ -2,5 +2,71 @@ As part of the shutdown of wiki.eclipse.org projects will need to move any conte |
|
|
|
|
|
|
|
In order to support this transition we're providing the following documentation for a couple of different options.
|
|
|
|
|
|
|
|
**Exporting from Wiki.eclipse.org**
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
## This seems like a pain, any automated options?
|
|
|
|
|
|
|
|
For the download and conversion steps, yes!
|
|
|
|
|
|
|
|
You can use the [WikiCrawler](https://github.com/msohn/EclipseWikiCrawler) tool created by one of our community members.
|
|
|
|
|
|
|
|
This tool does require that your wiki content be correctly categorized, and it leverages Docker and Pandoc to extract and convert content which you can then import directly into Gitlab/Github wikis(see the import section below).
|
|
|
|
|
|
|
|
Check out the documentation for WikiCrawler if you have any specific questions about how to use it.
|
|
|
|
|
|
|
|
## Manually exporting from Wiki.eclipse.org
|
|
|
|
|
|
|
|
The process of extracting content from a MediaWiki install starts with the [Special:Export](https://wiki.eclipse.org/Special:Export) page.
|
|
|
|
|
|
|
|
If your existing content is correctly gathered under :Category: tags, you can simply add the Category tag to the top textbox and then click 'add'.
|
|
|
|
|
|
|
|
In other cases where the content is spread out you can export it by adding the page names(including the 'path') of the pages you want to export. In the image below we're exporting 2 different FAQs; the Webmaster FAQ which lives at https://wiki.eclipse.org/Webmaster_FAQ and the CDT User FAQ which lives at https://wiki.eclipse.org/CDT/User/FAQ.
|
|
|
|
|
|
|
|
NOTE: Page names are case sensitive, so if your content isn't exporting start by making sure that the case of the pagename is correct in the export dialog.
|
|
|
|

|
|
|
|
|
|
|
|
Once you've added your pages click the 'Export' button. By default this will open a new tab with all of the page content as a single XML file, so you'll want to make sure the 'save as file' option is checked(see above image).
|
|
|
|
|
|
|
|
Having all your content in a single file may not be desirable, in which case you'll probably want to export each wiki page into it's own XML file.
|
|
|
|
|
|
|
|
## Manually converting to other Wiki formats
|
|
|
|
|
|
|
|
If you are importing your content into another MediaWiki instance, you should simply be able to provide the XML file content as input to the 'Special:Import' page at the new location.
|
|
|
|
|
|
|
|
For wikis on Gitlab/Github you will need to convert the XML wrapped MediaWiki format into a compatible Markdown format. There are a few tools that can provide this kind of translation, but for this example we'll use [Pandoc](https://pandoc.org/) .
|
|
|
|
|
|
|
|
You can convert the XML file as follows:
|
|
|
|
```
|
|
|
|
pandoc -s -f mediawiki -t gfm $YOUR-XML-FILE.xml -o $OUTPUT-FILE.md
|
|
|
|
```
|
|
|
|
|
|
|
|
Once the content has been converted it's ready to be imported.
|
|
|
|
|
|
|
|
## Importing content to Gitlab/Github
|
|
|
|
|
|
|
|
Importing your content to it's new home at Gitlab/Github is pretty much the same as working with any other code repository.
|
|
|
|
|
|
|
|
Both Gitlab and Github require you create a single wiki page(it doesn't have to be anything other than 'Hello World') before you can clone it like a regular code repo, so do that first.
|
|
|
|
|
|
|
|
You can find examples of the wiki clone URLs for both Gitlab/Github below.
|
|
|
|
|
|
|
|
Once you've cloned the repo, you can add the .md files created previously and then just add and commit them as you normally would.
|
|
|
|
|
|
|
|
And that's it. After that you can make changes either via the Gitlab/Github web UIs or directly by editing and committing the files.
|
|
|
|
|
|
|
|
**Gitlab**
|
|
|
|
Clone command:
|
|
|
|
```
|
|
|
|
git clone git@gitlab.eclipse.org:path/projectrepo.wiki.git
|
|
|
|
```
|
|
|
|
For example to clone this particular wiki you'd use:
|
|
|
|
```
|
|
|
|
git clone git@gitlab.eclipse.org:eclipsefdn/helpdesk.wiki.git
|
|
|
|
```
|
|
|
|
|
|
|
|
**Github**
|
|
|
|
Clone command:
|
|
|
|
```
|
|
|
|
git clone git@github.come:path/projectrepo.wiki.git
|
|
|
|
```
|
|
|
|
|