Changes between Version 1 and Version 2 of DevIntroTutorial


Ignore:
Timestamp:
Apr 3, 2017 3:36:58 AM (2 years ago)
Author:
butler
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • DevIntroTutorial

    v1 v2  
    1212* 3 min - goals and outline 
    1313* 20 min - Demo of existing functionality - going through all the menu items and buttons 
    14 * 10 min - Getting Help and Bug reporting -- tickets (user list, help@) - Needs: reporting bugs and responders to queries (from “how do i” to “why does my model not fit my data”) 
    15 * 10 min - How to write and distribute a model and the model marketplace. Needs: contributing models 
    16 * 35 min - Code structure (where bits live) - Needs: contributing non model code and testing and validation 
     14* 10 min - Getting Help and Bug reporting -- tickets (user list, help@) - '''Needs:''' ''reporting bugs and responders to queries (from “how do i” to “why does my model not fit my data”)'' 
     15* 10 min - How to write and distribute a model and the model marketplace. '''Needs:''' ''contributing models'' 
     16* 35 min - Code structure (where bits live) - '''Needs:''' ''contributing non model code and testing and validation'' 
    1717 * 5 min - !SasView, sasmodels, bumps 
    1818 * 20 min !SasView 
     
    2020  * 10 min - sasCalc 
    2121 * 10 min - sasmodels 
    22 * 20 min - Documentation - Needs: contributing documentation 
     22* 20 min - Documentation - '''Needs:''' ''contributing documentation'' 
    2323 * 5 min - Overview  
    2424  * Use Sphinx to build both dev and user 
    2525  * Uses RST and Latex - currently builds html but plan for a pdf also 
    26  * 4 min - Dev - Needs: lots of doc strings still missing 
     26 * 4 min - Dev - '''Needs:''' ''lots of doc strings still missing'' 
    2727  * 4 min - docstrings at the start of “each” class and method 
    28  * 10 min - User - Needs: never finished  
     28 * 10 min - User - '''Needs:''' ''never finished''  
    2929  * 5 min - each section has an RST file (and images as appropriate) 
    3030  * 5 min - Models = the first doc string in the file is scraped to go into model documentation 
    31   * 1 min - Tutorial …. Need a new one - Needs: help developing tutorial materials 
     31  * 1 min - Tutorial …. Need a new one - '''Needs:''' ''help developing tutorial materials'' 
    3232* 37 min - “Dev ops” 
    33  * 2 min - Basic concepts in version control - EVERYTHING is under version control!! 
     33 * 2 min - Basic concepts in version control - '''EVERYTHING''' is under version control!! 
    3434 * 10 min Git code hosting 
    3535  * 7 min - Concepts in version control (repos, cloning, branching (vs. forking - baaaad), committing (with comments),pull requests, code review 
    3636  *3 min - Setting notifications etc  
    37  * 25 min - “show me the code”- Needs: developers of all stripes = architecture, GPU, math whiz, sysadmins, ... 
     37 * 25 min - “show me the code”- '''Needs:''' ''developers of all stripes = architecture, GPU, math whiz, sysadmins, ...'' 
    3838  * 5 min - Git code repos (all of them), branches, stats… and CODE 
    3939  * 5 min - Compiling/run.py and local environment