Changes between Initial Version and Version 1 of Contribute/Documentation


Ignore:
Timestamp:
11/01/12 04:32:02 (12 years ago)
Author:
Michael Howden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Contribute/Documentation

    v1 v1  
     1[[TOC]]
     2= Contribute: 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== Easy ==
     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 all historic references to the "deployment_template" folder from the Sahana Eden wiki and [wiki:Book].
     10
     11=== Test Developers Installation Documentation for Windows ===
     12Follow 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:
     131. Summary of the exact steps you tool
     142. Screenshots of Sahana Eden installed on your OS
     153. How long it took you?
     164. What was the most difficult part?
     175. 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.
     186. Any other questions you may have about Sahana Eden
     19
     20=== Test Developers Installation Documentation for Mac ===
     21Follow 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:
     221. Summary of the exact steps you tool
     232. Screenshots of Sahana Eden installed on your OS
     243. How long it took you?
     254. What was the most difficult part?
     265. 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.
     276. Any other questions you may have about Sahana Eden
     28
     29=== Test Developers Installation Documentation for Linux ===
     30Follow 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:
     311. Summary of the exact steps you took
     322. Screenshots of Sahana Eden installed on your OS
     333. How long it took you?
     344. What was the most difficult part?
     355. 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.
     366. Any other questions you may have about Sahana Eden
     37
     38=== Test Developers Installation Documentation for Amazon EC2 ===
     39Follow 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:
     401. Summary of the exact steps you took
     412. Screenshots of Sahana Eden installed on Amazon EC2
     423. How long it took you?
     434. What was the most difficult part?
     445. 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.
     456. Any other questions you may have about Sahana Eden
     46
     47=== Test Customization Documentation ===
     48Follow 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:
     491. Screen Shots of your customized module
     502. How long it took you?
     513. What was the most difficult part?
     524. 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.
     536. Any other questions you may have about Sahana Eden
     54
     55=== Test Building a New Module Documentation ===
     56Follow 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:
     571. Screen Shots of your new module
     582. How long it took you?
     593. What was the most difficult part?
     604. 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.
     616. Any other questions you may have about Sahana Eden
     62
     63=== Add Screen Shots to Building a New Module Documentation ===
     64Follow 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:
     651. 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
     662. How long it took you?
     673. What was the most difficult part?
     684. 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.
     696. Any other questions you may have about Sahana Eden
     70
     71== Intermediate ==
     72
     73=== Prepare data model relationship entity diagram for each module in Sahana Eden ===
     74Can 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.
     75
     76=== Write blueprint to add transliteration to text entry controls ===
     77Proposed by: [http://lirneasia.net/profiles/nuwan-waidyanatha | Nuwan][[BR]]
     78'''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]]
     79'''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]]
     80'''Attainable  : ''' [[BR]]
     81Step 1 :: research the available Python/web2py transliteration engines [[BR]]
     82Step 2 :: trial/experiment with each one to determine the best [[BR]]
     83Step 3 :: develop a set of recommendations for embedding a generic transliteration engine in Eden [[BR]]
     84Step 4 :: discuss the recommendations with Sahana community [[BR]]
     85Step 5 :: document the specifications for developing the agreed on transliteration functionality [[BR]]
     86'''Relevant    : ''' In community-based disaster management literacy skills including English is poor. Important to develop flexible usable software for inclusiveness [[BR]]
     87'''Time-bound  : ''' No more than a few days to research the Internet. Another several days to discuss and finalize on the design specifications.
     88'''Evaluate    : ''' The recommended design would be discussed by the community to evaluate its workability. [[BR]]
     89'''Reevaluate  : ''' Validate the final specifications document. [[BR]]
     90
     91== Write/Update User Guidelines for a Module ==
     92Write generic User Guidelines wiki page for a Sahana Eden module based on:
     93* [http://demo.eden.sahanafoundation.org/ The Sahana Eden Demo Site]
     94* Existing UserGuidelines
     95* User Guidelines which have been written for specific deployments of Sahana Eden:
     96 * [wiki:UserGuidelinesEUROSHA]
     97 * [https://docs.google.com/document/d/1gYOqPp2m26uvC5-lDH5OSOM8LZTZOungBTkLLeerM6A/edit RMS User Guide]
     98
     99== Advanced ==
     100
     101----
     102[wiki:Contribute]