GitHub User Documentation

Github

The Github facility offers us several ways to craft documentation and ‘how to’s for our users.

Wiki

The wiki feature for each repository gives us a way to build interactive guides, instructions, install plans, etc. I don’tknow much about this yet, though will explore it in more detail later and report back to you when i figure it out.

Reference documents that explain a lot of detail can be found here for gh-pages. A nice guide to use the inbuilt web page generator can be found here.gh-pages

Approach Two

Craft a website page within the Github framework that applies to the user – something along the lines of a global page per user. Each Github user can have one of these. To do so, we add a repository to our online github accout with a particular naming convention.  For example if my user identity for Git hub was ‘fred’, then i would make a repository named fred/fred.github.com and our readers would use a browser address of fred.github.com to read up on our latest exploits !  These are known as user pages.

Approach Three

Generate a website for each of our repositories. These are known as project pages and a generator is available to produce a draft website. The generator offers a choice of styles for our websites. Once we choose a style and generate it with some preliminary content, it becomes available to our users. A browser address like http://fred.github.com/xxxx/ would offer access to the per-repository feature. ‘fred’ would be replaced by your own github user account and the ‘xxxx’ is the name of your repository.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s