WikiEditing

Editing the Wiki

Github supports many different types of wiki text formats. We're using reStructuredText because it's the format used by Sphinx, a documentation tool used by most Python projects.

The easiest way to edit the wiki is with Github's web interface. But if you want more flexibility, you can check out the wiki source and work with it on your own computer.

One-time setup:

1. [sudo] gem install gollum (see the Gollum README)
2. git clone git@github.com:osupython/organization.wiki.git
3. pip install docutils to get the reStructuredText tools. You might want to do this in a virtualenv.

To edit and view the changes:

1. Edit the wiki files...
2. Commit the changes (this is required for them to show up in the next step)
3. From the wiki source directory: gollum
4. Browse to http://localhost:4567
5. Push the changes back to Github