Updating the Story: The "Wiki" Tab - OpenSourceMalaria/TechOps GitHub Wiki

The wiki acts as an overall summary of everything in the project and should be written such that first-timers can use it to catch up on what’s been done on the project. A new wiki page can be created by clicking “New Page.” The navigation panel is on the right side of the page. In order for a new page to show up here, it must be added by clicking the pencil and editing the navigation panel. As with any wiki, the easiest way to see how things are done is by going to “edit” a page and looking at what other people have written there.

Formatting

GitHub has a comprehensive guide to formatting Issue comments and wiki pages here.

The formatting bar is displayed when writing a new Issue or wiki page, or when editing an old one. When editing an old page, you can copy/paste the formatting syntax already present to make sure the formatting is cohesive.

Similar to Issues, the wiki also has a “Preview” tab which lets you see what the text will look like when displayed on the web page so you can check what it will look like before publishing it.

Adding Images

Images cannot be added to the wiki by copy/pasting or clicking/dragging. The files must first be uploaded to the repository in the code tab (there is usually a folder titled “Wiki Files”), and then inserted. Clicking the image symbol on the formatting bar will help you ensure that the image will display correctly.

The image URL can be found by navigating to the file in the "code" tab and copying the web address. It should look something like this: https://github.com/OpenSourceMalaria/Series4/blob/master/Wiki%20Files/Amide%20Library%20v2.cdx