Skip to content

making an wiki page

Jump to bottom
sardap edited this page Mar 12, 2019 · 1 revision

Making a wiki page

Wiki pages must be created for project-wide documentation for the following topics.

  • Spike Reports
  • Guides
  • Code Documentation
  • Architecture pages

Non-specific instructions

  1. Clone the wiki repo.
https://github.com/sardap/Capstone-2019-Data-Sharing.wiki.git
  1. Create a branch Example:
git checkout -b "Making_an_wiki_page"

  1. Create the file (I'm not telling you how). However, filenames should be in lowercase-dashed.

  2. Write your page can use the following formats

  • Markdown
  • Creole
  • AsciiDoc
  • MediaWiki
  • Org-mode
  • Pod
  • RDoc
  • Textile
  • reStructuredText But please use Markdown where possible because of ease of editing.

  1. Refer to the below section and find any topic specific pages.

  2. Switch to the master branch

git checkout master
  1. Merge your new page(s) into the wiki.
git merge YOUR_WIKI_PAGE_BRANCH

For Spike Report

Refer here

Guides

Please make them clear and be willing to update if someone cannot understand the guide.

Code Documentation

TBD

Architecture pages

TBD

Home

Spike reports

About

Documents

Clone this wiki locally