Changes between Initial Version and Version 1 of Event/2012/GCI/Document


Ignore:
Timestamp:
11/01/12 17:06:32 (12 years ago)
Author:
Mark Prutsalis
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Event/2012/GCI/Document

    v1 v1  
     1[[TOC]]
     2= GCI Tasks: Documentation =
     3These task are great for people who are good at writing clear documentations or thorough at reviewing and editing existing documentation. As this is a software project, you may need some technical expertise for some of the projects.
     4
     5== Sahana Eden ==
     6
     7=== Update Wiki ===
     8* Review the flow & navigability of the wiki and send an email to the groups.google.com/group/sahana-eden list with any improvements that you would like to make.
     9* Recently Sahana Eden implemented new [wiki:DeveloperGuidelines/Templates Template] functionality which made the "deployment_template" folder redundant. Remove or update all historic references to the "deployment_template" folder from the Sahana Eden wiki and [wiki:Book].
     10* Recently Sahana Eden migrated from using BZR to Git (DeveloperGuidelines/Git). Remove or update all out-of-date references to BZR from the Sahana Eden wiki and [wiki:Book].
     11
     12=== Test Developers Installation Documentation for Windows ===
     13Follow the documentation on http://eden.sahanafoundation.org/wiki/InstallationGuidelines to install a developer's instance of Sahana Eden on your Windows OS. Once you have completed send an email to the groups.google.com/group/sahana-eden list stating:
     141. Summary of the exact steps you tool
     152. Screenshots of Sahana Eden installed on your OS
     163. How long it took you?
     174. What was the most difficult part?
     185. 3 improvements you would like to make - these need to be as specific as possible - does content need to be added? Clarified? Simplified? Is there a need for pictures (of what?)?. Ideally you will edit the documentation on the Wiki to make these improvements yourself.
     196. Any other questions you may have about Sahana Eden
     20
     21=== Test Developers Installation Documentation for Mac ===
     22Follow the documentation on http://eden.sahanafoundation.org/wiki/InstallationGuidelines to install a developer's instance of Sahana Eden on your Mac OS. Once you have completed send an email to the groups.google.com/group/sahana-eden list stating:
     231. Summary of the exact steps you tool
     242. Screenshots of Sahana Eden installed on your OS
     253. How long it took you?
     264. What was the most difficult part?
     275. 3 improvements you would like to make - these need to be as specific as possible - does content need to be added? Clarified? Simplified? Is there a need for pictures (of what?)?. Ideally you will edit the documentation on the Wiki to make these improvements yourself.
     286. Any other questions you may have about Sahana Eden
     29
     30=== Test Developers Installation Documentation for Linux ===
     31Follow the documentation on http://eden.sahanafoundation.org/wiki/InstallationGuidelines to install a developer's instance of Sahana Eden on your Linux OS. Once you have completed send an email to the groups.google.com/group/sahana-eden list stating:
     321. Summary of the exact steps you took
     332. Screenshots of Sahana Eden installed on your OS
     343. How long it took you?
     354. What was the most difficult part?
     365. 3 improvements you would like to make - these need to be as specific as possible - does content need to be added? Clarified? Simplified? Is there a need for pictures (of what?)?. Ideally you will edit the documentation on the Wiki to make these improvements yourself.
     376. Any other questions you may have about Sahana Eden
     38
     39=== Test Developers Installation Documentation for Amazon EC2 ===
     40Follow the documentation on http://eden.sahanafoundation.org/wiki/InstallationGuidelines to install a developer's instance of Sahana Eden on Amazon EC2. Once you have completed send an email to the groups.google.com/group/sahana-eden list stating:
     411. Summary of the exact steps you took
     422. Screenshots of Sahana Eden installed on Amazon EC2
     433. How long it took you?
     444. What was the most difficult part?
     455. 3 improvements you would like to make - these need to be as specific as possible - does content need to be added? Clarified? Simplified? Is there a need for pictures (of what?)?. Ideally you will edit the documentation on the Wiki to make these improvements yourself.
     466. Any other questions you may have about Sahana Eden
     47
     48=== Test Customization Documentation ===
     49Follow the documentation on http://en.flossmanuals.net/sahana-eden/customisation/ to customize your local instance of Sahana Eden. Once you have completed send an email to the groups.google.com/group/sahana-eden list with:
     501. Screen Shots of your customized module
     512. How long it took you?
     523. What was the most difficult part?
     534. 3 improvements you would like to make - these need to be as specific as possible - does content need to be added? Clarified? Simplified? Is there a need for pictures (of what?)?. Ideally you will edit the documentation on the Wiki to make these improvements yourself.
     546. Any other questions you may have about Sahana Eden
     55
     56=== Test Building a New Module Documentation ===
     57Follow the documentation on http://en.flossmanuals.net/sahana-eden/building-a-new-application/ to customize your local instance of Sahana Eden. Once you have completed send an email to the groups.google.com/group/sahana-eden list with:
     581. Screen Shots of your new module
     592. How long it took you?
     603. What was the most difficult part?
     614. 3 improvements you would like to make- these need to be as specific as possible - does content need to be added? Clarified? Simplified? Is there a need for pictures (of what?)?. Ideally you will edit the documentation on the Wiki to make these improvements yourself.
     626. Any other questions you may have about Sahana Eden
     63
     64=== Add Screen Shots to Building a New Module Documentation ===
     65Follow the documentation on http://en.flossmanuals.net/sahana-eden/building-a-new-application/ to customize your local instance of Sahana Eden. Once you have completed send an email to the groups.google.com/group/sahana-eden list with:
     661. Screen Shots of your new module. You will need to take the relevant sections of these screen shots and add them into the Book as examples
     672. How long it took you?
     683. What was the most difficult part?
     694. 3 improvements you would like to make - these need to be as specific as possible - does content need to be added? Clarified? Simplified? Is there a need for pictures (of what?)?. Ideally you will edit the documentation on the Wiki to make these improvements yourself.
     706. Any other questions you may have about Sahana Eden
     71
     72=== Prepare data model relationship entity diagram for each module in Sahana Eden ===
     73Can use MySQL workbench to reverse-engineer the Eden database into an ERR diagram, then tidy up to show the actually important information for developers (e.g. hide meta-fields, auth references and similar, annotate the foreign keys for links, move objects so they don't overlap too much), for an example see http://pub.nursix.org/eden/err_model.png.
     74
     75=== Write blueprint to add transliteration to text entry controls ===
     76Proposed by: [http://lirneasia.net/profiles/nuwan-waidyanatha | Nuwan][[BR]]
     77'''Specific    : ''' For local language text entry one can use a native language keyboard with native unicode character set or use transliteration to allow entering the native word phonetically. for example with [http://www.google.com/ime/transliteration/ | Google Transliteration Beta] or other plug-in like [ http://www.ucsc.cmb.ac.lk/ltrl/services/feconverter/t1.html | USCS's Real-Time Unicode Converter] [[BR]]
     78'''Measurable  : ''' Users in Sri Lanka, for example, prefer Sinhala or Tamil languages. Making the option for them to turn on transliteration in Sahana to enter critical information in the local language is an important usability aspect. [[BR]]
     79'''Attainable  : ''' [[BR]]
     80Step 1 :: research the available Python/web2py transliteration engines [[BR]]
     81Step 2 :: trial/experiment with each one to determine the best [[BR]]
     82Step 3 :: develop a set of recommendations for embedding a generic transliteration engine in Eden [[BR]]
     83Step 4 :: discuss the recommendations with Sahana community [[BR]]
     84Step 5 :: document the specifications for developing the agreed on transliteration functionality [[BR]]
     85'''Relevant    : ''' In community-based disaster management literacy skills including English is poor. Important to develop flexible usable software for inclusiveness [[BR]]
     86'''Time-bound  : ''' No more than a few days to research the Internet. Another several days to discuss and finalize on the design specifications.
     87'''Evaluate    : ''' The recommended design would be discussed by the community to evaluate its workability. [[BR]]
     88'''Reevaluate  : ''' Validate the final specifications document. [[BR]]
     89
     90=== !Write/Update User Guidelines for a Module ===
     91Write generic User Guidelines wiki page for a Sahana Eden module based on:
     92* [http://demo.eden.sahanafoundation.org/ The Sahana Eden Demo Site]
     93* Existing UserGuidelines
     94* User Guidelines which have been written for specific deployments of Sahana Eden:
     95 * [wiki:UserGuidelinesEUROSHA]
     96 * [https://docs.google.com/document/d/1gYOqPp2m26uvC5-lDH5OSOM8LZTZOungBTkLLeerM6A/edit RMS User Guide]
     97
     98----
     99[wiki:Contribute]