GitHub Importer Application

Version 5.2 by Hassan Ali on 2020/07/07 21:00

cogA Simplified UI to make the interaction user-friendly for the GitHub Importer.
TypeXAR
Category
Developed by

Hassan Ali

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

A Simplified UI to make the interaction user-friendly for the GitHub Importer.

Usage

  1. Open GitHub Importer Application from the Applications Panel.

GithubImporterUIx1.png
2. Fill the fields with your values.

  • Source: Link to your GitHub wiki repository. (Note that if you provide non wiki repository, it will automatically be directed to wiki directory since git directory is not recommended).
  • Parent Page: The root of the pages to be imported, to keep them in a defined space.
  • Authentication Code: The token / oauth / password of the GitHub user to clone protected repositories.
  • Username: The username of the GitHub user (Only needed if you are using the Authentication Code with Password).
  • Convert Syntax: Whether to convert the syntax to XWiki or not. Check to convert.
    3. Click the Convert button.

GithubImporterUIx1.png

Wait for the import to finish. If the import fails, check the Job log to see where the error occurs from.
If the import is successful, new pages will be created in your XWiki. Click on the Job log and check where the pages have been created. In case you can not see, reload the page and make sure you are looking for the parent.
Have fun!

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v1.1

Dependencies

Dependencies for this extension (org.xwiki.contrib.github-importer:github-importer-ui 1.1):

Get Connected