Introduction

The wiki is a usual Git repository while it’s not a Github project.

There are 3 URL associated with it:

So, here is what users can do:

  • non Github users:
    • clone
    • change locally
    • put it somewhere else
    • raw git pull requests
  • Github users:
    • all the above
    • oneline edit
    • push to it directly (?)
  • team maintainers:
    • push

The problem is that users are more used to Github projects, with pull requests available. So, to open the contributions, I made a mirror of the sources.

There are 3 more available URL:

This enable more, especially for the Github users:

  • better visibility (a classic Github project is on the projects page)
  • Github fork
  • Github pull requests

Making changes

Online

Github users can edit pages online.

Via Git

If you already have a local copy of the offlineimap repository, run the dedicated script.

$ ./scripts/get-repository.sh wiki

You’ll have a local copy of the sources. From there, make a fork of the mirror and add a reference to it like this:

$ cd wiki
$ git remote add myfork <repo-URL-to-the-fork>

Manually

$ git clone  offlineimap.wiki
$ cd offlineimap.wiki
$ git remote add myfork <repo-URL-to-the-fork>

What to do next

Push your changes to the last, make pull requests against the mirror.

  • origin is the upstream you can fetch from
  • myfork is where you push your change to make them public