Changes between Version 1 and Version 2 of User Guide/Wiki Style Guide


Ignore:
Timestamp:
Apr 29, 2020, 8:42:34 PM (4 years ago)
Author:
jkol
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • User Guide/Wiki Style Guide

    v1 v2  
    2121
    2222{{{
    23 [[TOC(SectionPageName/SubsectionPageName/*, depth=2, noheading)]]
     23[[TOC(SectionPageName/SubsectionPageName/*, depth=1, noheading)]]
    2424
    2525= Section Title
    … …  
    3131  ''Example:'' For this page, the top of the page says "''Editing test/ExperimenterInformation/WikiStyleGuide''", so the TOC macro should then be `[[TOC(test/ExperimenterInformation/WikiStyleGuide/*,depth=1)]]`. Don't forget to add the `/*` at the end of the wiki URL.
    3232
    33 The default TOC depth should be left at 2, unless it makes sense otherwise.
     33The default TOC depth should be left at 1, unless it makes sense otherwise.
    3434
    3535=== Individual Pages
    … …  
    4444Sub section content.
    4545}}}
     46
     47=== Tutorial Pages
     48
     49Please us the following document skeleton when writing a tutorial.
     50
     51{{{
     52{{{
     53[[TOC, noheading]]
     54
     55= Tutorial Title
     56
     57== Description
     58Description and goal of the tutorial described here...
     59
     60== Prerequisites
     61In order to access the test bed, create a reservation and have it approved by the reservation service. Access to the resources is granted after the reservation is confirmed. Please follow the process shown on [wiki:cosmos_workflow the COSMOS work flow page] to get started.
     62
     63== Resource Requirements
     64List of specific resources or requirements, including OMF image name if applicable.
     65
     66== Setup
     67Steps to setup the tutorial...
     68
     69== Execution
     70
     71=== The first thing you do
     72First step of the tutorial...
     73
     74=== The second thing you do
     75Second step of the tutorial...}}}
     76}}}