access_UtilsWG_UtilWgDocInstruction - ACCESS-NRI/accessdev-Trac-archive GitHub Wiki

PageOutline

ACCESS Utility Documentation Instruction

How to Create the Wiki for the Documentation

  • Go to the Documentation page https://accessdev.nci.org.au/trac/wiki/access/UtilsWG/UtilWgDocs
  • Log into the wiki using NCI account to enable the editing
  • Go the app (if app is not yet in the table, please add the app accordingly),
  • User Manual: in the box, add the [User Manual](https://github.com/ACCESS-NRI/accessdev-Trac-archive/wiki/access/UtilsWG/UtilWgDocs/$APP_um#); $APP is the name of the app; um for User Manual
  • Deployment Guide: in the box, add the [Deployment Guide](https://github.com/ACCESS-NRI/accessdev-Trac-archive/wiki/access/UtilsWG/UtilWgDocs/$APP_dg#); dg for Deployment Guide
  • Development Reference: in the box, add the [Development Reference](https://github.com/ACCESS-NRI/accessdev-Trac-archive/wiki/access/UtilsWG/UtilWgDocs/$APP_df#); df for Development Reference
  • Submit the change and click the newly added wiki link and follow the instruction to create the page for adding documentation

Instruction: User Manual

Instruction: Deployment Guide

Instruction: Development Reference