Documentation

From Cheaha
Revision as of 16:20, 2 November 2011 by Jpr@uab.edu (talk | contribs) (→‎Developer Guide: Add section link for web authentication)
Jump to navigation Jump to search


Attention: Research Computing Documentation has Moved
https://docs.rc.uab.edu/


Please use the new documentation url https://docs.rc.uab.edu/ for all Research Computing documentation needs.


As a result of this move, we have deprecated use of this wiki for documentation. We are providing read-only access to the content to facilitate migration of bookmarks and to serve as an historical record. All content updates should be made at the new documentation site. The original wiki will not receive further updates.

Thank you,

The Research Computing Team

Docs is a an open documentation platform for UAB built on the Mediawiki engine, the same wiki engine that powers Wikipedia. Content contributions to docs are welcome and encouraged. The breadth, depth, and value of our documentation is directly attributable to those who participate in its development.

Caveat Emptor: Some of information is of historical nature. We are actively reviewing and tagging outdated content to ensure it is updated.

Editing Docs

The only requirements to contribute content to Docs is to authenticate using an identity of your choice and respect the copyright of original material by following the guidelines used by Wikipedia. All material contributed to docs is governed by the Creative Commons Attribution and Share-Alike license referenced at the bottom of each page.

To create a new page, simply edit an existing page and add a reference to your new page by writing the new page's name inside double square brackets, as shown in the following example. Save your edit to the existing page along with a meaningful comment in the Summary text box noting the creation of a link to a new page. After saving this edit, you will see a link to your new page (in red). Follow that link to begin adding content to your new page. 

  [[My new page]]

Editing and refining content is as important as original contribution. The wiki model encourages capturing the natural evolution of knowledge. When editing content, please be sure to also make a note of the change in the Summary text box at the bottom of the edit window, eg. "spell check" for minor spelling corrections or "improve readability" for refining activities. If you intend to make major improvements or changes to content, please coordinate those changes with other editors of the content by engaging in a dialog on the pages' "Discussion" tab or by directly contacting the primary contributors for the page as identified on the "View History" tab. Again, the Wikipedia community practices provides value guidance on how to edit pages.

Interwiki links provide convenient shortcuts to the content in other wikis. One of the most useful interwiki link is "wikipedia" which creates links to articles in Wikipedia itself. These interwiki links can provide valuable background for material you are covering in docs. For example, when document an application you can reference the Wikipedia page for associated content relevant to your domain. To create an interwiki link, use the double square bracket convention as you would to link to another local page and simply prefix the Wikipedia article name with "wikipedia:". For example, this link to the Wikipedia article on wiki is constructed as follows: 

[[wikipedia:Wiki|wiki]]

The vertical bar separator is used to provide text that matches your page content rather than the raw content of the link name.

FAQ

User Guide

Developer Guide

Administrator Guide

Retrieved from "https://docs.uabgrid.uab.edu/w/index.php?title=Documentation&oldid=3440"