Caltech DGC Wiki:About
From DGC Wiki
Categories: Open action items | RMM action items | Closed action items | Dropped action items
DGC Wiki is the wiki system for Team Caltech. The wiki is used to document our system as well as keep track of information related to the project (implementation plans, test schedules, notes, etc). This page has some general information about the way the wiki is organized and some of the special features we have implemented.
- Using Wiki Documentation - Information for how to use the wiki (start here if you haven't used a wiki before)
Categories
DGC Wiki makes use of categories to identify certain types of information in the project. Here are some of the more common categories that we use:
- Category:Action items - list of all action items (with subcategories for open, closed and dropped)
- Category:Components - list of all hardware and software components in the system
- Category:Obsolete pages - list of all obsolete pages (usually these use the obsolete pages template)
- Category:Skynet modules - category for all Skynet (software) modules in the system
- Category:Merge pages - list of pages with merge tasks - merge pages template - under construction
Templates
General Purpose Templates
A number of templates are defined that can be used throughout this wiki to simplify data entry.
| Template category | Usage | Comments |
|---|---|---|
|
[edit] Check marks | {{check}}, {{x}}, {{inprogress}} | Use to generate ✔, ✗, ⌛ ("ongoing") |
|
[edit] Text edits | {{added|text}} | Mark an addition to a page. Use to mark large from original text (usually a new goal or objective). Same as {{insert}} |
| {{change|text}} | Mark a change to a page. Use to mark smaller changes from original text. | |
| {{comment|XYZ|text}} | Add a comment to a page (RMM: like this) | |
| <s>deletions</s> | Strike out a section of text | |
| {{insert|text}} | Same as {{added}} | |
| {{replace|old text|new text}} | Use to replace | |
|
[edit] Action items | {{openaction|XYZ|text}} | Create an action item. Action (RMM): Make sure to give an example |
| {{closedaction|XYZ|text}} | Mark an action item as done. | |
| {{droppedaction|XYZ|text}} | Mark an action item as dropped (no longer relevant). | |
|
[edit] Obsolete Pages | {{obsolete|New Page}} | The obsolete pages template places a large red banner at the top of a page saying that the page is obsolete and includes a link to a new page. |
|
[edit] Merge Pages | {{merge|Other Page}} | The merge pages template places a banner at the top of a paying suggesting that this page should be merged with the other page - mark both pages with this template |
Special Usage Templates
These templates have been created for rather customized purposes that are specific to Team Caltech.
| Category | Usage | Comments |
|---|---|---|
| Bugzilla | {{bug|number}} | 1000 |
| {{milestonebugs|milestone_text}} | List all bugs associated with a given milestone | |
| Agendas | {{agendabegin}} {{agendaitem|time|description }} || add'l cols {{agendaend}} | Create a simple agenda, with proper alignment of columns |
| {{daytimeitem|day|time}} || add'l cols | Variant that allow day and time in separate columns |
Data Templates
Templates are also used to store data that appears in multiple places in the wiki. These templates typically have built in anchors for editing the template and moving the the locations that the template is used (for ease of editing).
| Template format | Comments |
|---|---|
| Summer Wn Goals | Goals for Summer Wn test plan |
| Summer Wn milestonebugs|Severity | URL for milestones associated with with 'Wn'. The severity argument (usually 'Blocker') is optional. |
| One Day Field Test|args | Complex template used for creating test plans for single day field tests. See instructions at top. |
| Multi-Day Field Test|args | Complex template used for creating test plans for multi-day field tests. See instructions at top. |
![[Main Page]](../../../../upload/alice.jpg)