Wiki updates for RapidFTR Features - Response Requested

30 views
Skip to first unread message

Nandini Ravi

unread,
May 14, 2013, 11:42:19 AM5/14/13
to rapi...@googlegroups.com
Hello All,

We are considering updating the RapidFTR wiki to provide greater functional and technical context on key RapidFTR modules / features.

Why this is important :
While the design & implementation ideas were developed through discussions on the RapidFTR google group, updating the wiki will support knowledge sharing for all members of this growing community. Contributors will find it useful as they continue to build upon the existing application.

Initial list:
Here's an initial list of features whose functional & technical overview needs wiki updates:
  • Case Management Integration
    • Short-term and long-term API solution
    • Need to cover Why, What's new, changed / replaced, How  - [Some of it can be sourced from Akash Bhalla's email notes + inception deck diagrams + links to API links on wiki]
  • Forms - Why, how (seeding) etc, How it is created, by who and where (only via web app)
  • Reports - Purpose, design with screenshots, link to feature in Mingle  
  • Post-deployment configuration needed (Available as PDF - by Matthew Kasekende)
  • Change Log
  • User Action Log
  • System Action Log

How you can help :

It would be great if volunteers could review the list above & provide suggestions on any other existing features that should be covered.

Once a good list of high-priority items have been identified, the next step would be creating mingle cards for volunteers to sign-up to provide the Wiki content.

Gurpreet Luthra

unread,
May 14, 2013, 8:22:53 PM5/14/13
to rapi...@googlegroups.com
Some more things I think we should put on RapidFTR Wiki: 

Here we should mention step-by-step how we expect people to sign up in Mingle, and which walls to look at, and how to sign-up for a card -- and then explain the life-cycle of a story until it is marked as completed (pull request, code review, etc).

https://github.com/rapidftr/RapidFTR/wiki/Tools-being-used
Should mention intelliJ -- and a note about people to use the Community License version. 

Where does the Wiki have information about Google Groups to Join? And IRC Chat? I strongly recommend a comprehensive page (with links) like this for RapidFTR: 

From Features Perspective: 
 - Blocking of a Stolen Mobile Phone
 - How does RapidFTR handle the fact that one user cannot see another user's data on the same mobile phone
 - Verified and Un-verified user sceanrios (or introduction to both -- if we are supporting Unverified user scenarios)
 - Details on Android platform (and devices) being supported -- and why?


Regards
Gurpreet

Join the Humanitarian Software Program to help and contribute OpenMRS, RapidFTR, Camfed and MifosX SIP Projects. We are looking for Volunteers!


--
You received this message because you are subscribed to the Google Groups "rapidftr" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rapidftr+u...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

Nandini Ravi

unread,
May 23, 2013, 2:43:20 AM5/23/13
to rapi...@googlegroups.com
Gurpreet,

Thanks for your suggestions.

"[..] we should mention step-by-step how we expect people to sign up in Mingle, and which walls to look at, and how to sign-up for a card -- and then explain the life-cycle of a story until it is marked as completed (pull request, code review, etc)."

- Yes, this will be very useful. It came up during the code jam we had in chennai on may 17 2013


Where does the Wiki have information about Google Groups to Join? And IRC Chat? I strongly recommend a comprehensive page (with links) like this for RapidFTR:

Joining the IRC and link to the google groups is available in rapidftr.com and here
https://github.com/rapidftr/RapidFTR---Android/wiki/How-to-contribute
But we were think it's probably best to have a single consolidated page for 'How to Contribute'  (with all of the details on IRC, Mingle, g-groups) that would be referenced from both android and web app wiki.

From Features Perspective: 
 - How does RapidFTR handle the fact that one user cannot see another user's data on the same mobile phone
 
This has been addressed here https://github.com/rapidftr/RapidFTR---Android/wiki/Security-Approach
and

 - Verified and Un-verified user sceanrios (or introduction to both -- if we are supporting Unverified user scenarios)

has been described here (probably needs a better title) https://github.com/rapidftr/RapidFTR---Android/wiki/User-Scenarios

Please review the above links and let us know what else you think needs to be covered in these topics.

I will create cards for the items you mentioned and the list i put out.

Thanks,

Nandini Ravi

unread,
May 24, 2013, 5:44:24 AM5/24/13
to rapi...@googlegroups.com
The following cards have been created and available for sign-up
  • 1832 - [Wiki Documentation] "How to Contribute to RapidFTR" - The contents can be further broken up into separate stories if multiple volunteers would like to work on the various items. If there are other items that need to be covered, please post your notes in the comments section.
Additional notes:

Gurpreet Luthra

unread,
May 24, 2013, 6:13:56 AM5/24/13
to rapi...@googlegroups.com
>>intelliJ Idea & community license : Has been covered here -https://github.com/rapidftr/RapidFTR---Android/wiki/Project-setup 
Does this need more updates ?

I added a reference to this page in the https://github.com/rapidftr/RapidFTR/wiki page under the section "Setting up your Workstation for Development". I don't think we need to mention anything more. Thanks! 

Regards
Gurpreet

Join the Humanitarian Software Program to help and contribute OpenMRS, RapidFTR, Camfed and MifosX SIP Projects. We are looking for Volunteers!


Nandini Ravi

unread,
May 30, 2013, 1:31:50 PM5/30/13
to rapi...@googlegroups.com
Team,

Had a brief wiki-update jam this evening in the Chennai ThoughtWorks office and made the following updates:

  • Grouped all functionality related documentation under Functional & Technical Overview of Feature Modules This is still a work-under-progress at this time.  Updates to existing documentation + documentation on other feature components (mentioned above) will be added over the next few days.

    

-Nandini, Sanchari, Vikhyath and Gowri

Nandini Ravi

unread,
May 30, 2013, 1:39:00 PM5/30/13
to rapi...@googlegroups.com
Team,

Had a brief wiki-update jam this evening in the Chennai ThoughtWorks office and made the following updates:

  • Grouped all functionality related documentation under Functional & Technical Overview of Feature Modules This is still a work-under-progress at this time.  Updates to existing documentation + documentation on other feature components (mentioned above) will be added over the next few days.

  
Volunteers are welcome to make pertinent changes or share suggestions.


-Nandini, Sanchari, Vikhyath and Gowri
On Fri, May 24, 2013 at 3:43 PM, Gurpreet Luthra <glu...@thoughtworks.com> wrote:
>>intelliJ Idea & community license : Has been covered here -https://github.com/rapidftr/RapidFTR---Android/wiki/Project-setup 
Does this need more updates ?

I added a reference to this page in the https://github.com/rapidftr/RapidFTR/wiki page under the section "Setting up your Workstation for Development". I don't think we need to mention anything more. Thanks! 

Regards
Gurpreet

Join the Humanitarian Software Program to help and contribute OpenMRS, RapidFTR, Camfed and MifosX SIP Projects. We are looking for Volunteers!


On 24 May 2013 15:14, Nandini Ravi <nand...@thoughtworks.com> wrote:
The following cards have been created and available for sign-up
  • 1832 - [Wiki Documentation] "How to Contribute to RapidFTR" - The contents can be further broken up into separate stories if multiple volunteers would like to work on the various items. If there are other items that need to be covered, please post your notes in the comments section.

Gurpreet Luthra

unread,
May 30, 2013, 4:54:02 PM5/30/13
to rapi...@googlegroups.com
The first steps you have taken look really good! Thanks a lot! 

Regards
Gurpreet

Join the Humanitarian Software Program to help and contribute OpenMRS, RapidFTR, Camfed and MifosX SIP Projects. We are looking for Volunteers!


sabh...@thoughtworks.com

unread,
Jun 10, 2013, 2:01:54 AM6/10/13
to rapi...@googlegroups.com
Hi,

I am a new contributor to RapidFTR from Thoughtworks.

I just started on gaining the functional context and set up of my dev box. The GitHub wiki is quite detailed and the setup instructions were very clear for a newbie to the project. Kudos to the team!!

I noticed few things to be updated though.
  1. The mingle and github links in rapidftr developer info page are still pointing to the old links. The developer info link on the right of the page could also be removed which is pointing back to the same page. 
  2. Key entities link in architectural overview wiki is blank. That needs an update.
  3. I have also updated the instructions for admin user creation for couch db from the UI.
Thanks.
Reply all
Reply to author
Forward
0 new messages