From De Pablo Group Computing
Wiki Style Guide
The purpose of this page is to establish a basis for wiki content and how it is presented. All users are required to read this page before they are given an account (email email@example.com to get wiki access). All content should meet the following requirements:
- Entries should be written to the level of a complete Linux newcomer. Please do not assume that your reader understands how to compile source code, which dependencies are necessary to get started, or has ever used condor before in any form.
- All entries should be written in complete sentences with proper grammar. Use of acronyms is encouraged. Use the same level of professionalism you would in writing an email to Juan.
- Entries should focus on performing clearly defined tasks (i.e. submit a job to GLOW, providing a summary of basic Linux commands). The wiki is not intended as a repository for documentation, it is a guide to help users rapidly gain familiarity with specific topics.
- Entries should be complete. References to external documentations are for further reading only, and should not be relied on to explain the remainder of a task.
- Provide all relevant code and condor submit files. For example, if you are demonstrating how to submit an MPI job, provide an example executable for the user to run, in addition to the condor-related materials.