• Simon Urli
• Vincent Massol

• Hassan Ali

2 man month

The idea is to develop an importer to import GitHub pages written in GitHub-flavored Markdown into XWiki pages written in XWiki Syntax 2.1.

To do that you would use the following existing modules in XWiki:

• Filter Application. This is a generic framework and UI to convert from one format to another.
  • Filter Module
  • XWiki instance output filter
• You can use examples of existing importers:
  • Confluence Importer
  • MediaWiki Importer
  • DokuWiki Importer
• Markdown Syntax
• Git API

Here's an idea of a possible implementation workflow:

• Since there's no GitHub REST API to access GitHub wiki pages, use the XWiki Git API to checkout/clone the underlying Git repo containing the GitHub wiki pages.
• Write an input Filter that takes as input a Git repo containing GitHub wiki pages. Use the existing XWiki Instance output filter to convert that into wiki pages.
• Use the Markdown Syntax to parse the GitHub pages and use XWiki Rendering APIs to convert that to XWiki Syntax 2.1
• See this snippet to import from GitHub

Knowledge required:

• Java

2020

Selected

Google Summer of Code 2020 Report

GitHub Importer - XWiki

Mentors: Vincent Massol, Simon Urli.

Student: Haxsen (Hassan Ali)

Introduction

GitHub Importer is an XWiki extension which provides the ability to import and convert pages from GitHub to XWiki with various features.
Technologies: JAVA, MAVEN, XML, XWiki, Docker.

Project links

• Source Code: Main Repository
• Discussion: Forum

Output

• GitHub Importer Application
• GitHub Importer Filter

Work Summary

Roadmap v1.0

• GHIMPORT-1: Ability to import GitHub pages to XWiki
  • JIRA
  • Commit

Released 1.0: Forum post

Roadmap v1.1

• GHIMPORT-7: Create user friendly simplified UI
  • JIRA
  • Commit
• [Misc] Added Integration tests.
  • Commit
  • Commit

Released 1.1: Forum post

Roadmap v1.2

• GHIMPORT-9: The conversion should be done with the xwiki default syntax and not hardcoded to xwiki/2.1
  • JIRA
  • Commit
• GHIMPORT-3: Organize pages hierarchically according to the Sidebar
  • JIRA
  • Commit
• GHIMPORT-10: Rephrase all hints in the UI to be more precise and useful
  • JIRA
  • Commit
• GHIMPORT-8: Create docker tests to test the features
  • JIRA
  • Commit

Released 1.2: Forum post

Roadmap v1.3

• GHIMPORT-25: Add support for zip file source
  • JIRA
  • Commit1
  • Commit2
• GHIMPORT-19: Only top level pages are imported
  • JIRA
  • Commit
• Some important fixes.
  • Commit
• GHIMPORT-11: Add validation and make mandatory fields visible
  • JIRA
  • Commit

Released 1.3: Forum post

Roadmap v1.4

• GHIMPORT-29: Page author is not correctly assigned
  • JIRA
  • Commit
• GHIMPORT-21: Internationalize the application
  • JIRA
  • Commit
• GHIMPORT-26: Forbid creating pages under existing Parent
  • JIRA
  • Commit
• GHIMPORT-23: Add support for mediawiki and creole syntaxes
  • JIRA
  • Commit

Released 1.4: Forum post

Roadmap v1.5

• GHIMPORT-34: Parent Page is not picked correctly
  • JIRA
  • Commit
• GHIMPORT-36: Failure to import https://github.com/nebulasio/wiki.wiki.git
  • JIRA
  • Commit
• GHIMPORT-33: Improve hierarchical importing
  • JIRA
  • Commit
• GHIMPORT-37: Don't loose the entered data when there's a job failure
  • JIRA
  • Commit
• GHIMPORT-39: Add a link to the result after import and provide a home page for the import
  • JIRA
  • Commit
• GHIMPORT-40: Broken links when importing https://github.com/kbroman/simple_site.git
  • JIRA
  • Commit

Released 1.5: Forum post

Full Work

Total releases: 6
All JIRA issues fixed by me.

Code committed by me.

What's Next

• Roadmap v1.6 (Done here).
• Release 7 (v1.6).
• Track it here.

Experience

My experience was great in this journey of creating a new extension for an open source organization. I learned a lot and my mindset has tilted more towards contributing to help the world grow!

Mentors

My mentors were very helpful throughout the project and communication was readily available on the chat. They greatly improved my knowledge as well as skills.