Skip to content

Wiki contributing

tstagge edited this page May 19, 2021 · 4 revisions

Contributing to the Git Wiki

Command Line & Local Repo

Repo Setup

To use an editor on your computer and interact with github, you will need to clone two repos. First there is the actual ROV-Wiki repo (and ssh link: [email protected]:purduerov/ROV-Wiki.git). Then there is the wiki pages repo (notice the extra .wiki) in the address. I have both cloned to a folder (ROV-Wiki) with the plain repo and wiki repo each as subfolders.

Web interface

Don't be bad. Just use the command line interface. <= Fuck you Grant. This is just a wiki. Feel free to upload pictures through the web interface.

File/Folder Structure

All wiki page files are stored as Markdown files in the wiki repo with no sub folders. To get started, create a new file in the directory if working on local repo or click "New Page" on the web interface.

File Naming

Please do not use spaces or any disallowed filename characters (#%&{}<>*?/$!'":@) in naming pages. Page names should only contain alphanumeric characters (A-Za-z0-9), dashes (-), and underscores(_).

Links

To insert links to a wiki page, use standard markdown link formating [text](address). For linking to a page in the wiki (address) can just be the wiki/page name (ex: wiki/X12-Frame; note there is no .md extension too). HOWEVER: if you are editing _Sidebar.md, the wiki/ is already there implicitly and you should just enter the page name.

Markdown reference

If you're reading this, then you probably got into Purdue, so you're smart enough to Google "markdown guide" or "how to ... in markdown". However, I am generous and will put a link here for your convenience.

Clone this wiki locally