Fwd: [Architecture] Comprehending the code

Colin Clark colinbdclark at gmail.com
Thu Jun 18 11:54:18 EDT 2015


Hi all,

We knew it was going to be a painful migration process while we moved Infusion's documentation from our wiki to our shiny new static site generator. I wonder if there's a way we can make this easier on new users in the short term?

Any suggestions?

Colin

> Begin forwarded message:
> 
> From: Alfredo Matas <alfredo at raisingthefloor.org>
> Subject: Re: [Architecture] Comprehending the code
> Date: June 9, 2015 at 2:51:29 PM EDT
> To: Steve Lee <steve at opendirective.com>
> Cc: "architecture at lists.gpii.net Architecture" <architecture at lists.gpii.net>
> 
> On Tue, Jun 9, 2015 at 7:00 PM, Steve Lee <steve at opendirective.com <mailto:steve at opendirective.com>> wrote:
> HI
> 
> Alfredo, Wayne and myself have been exploring the APfP code at various times and find it difficult. I think a part of the problem is the code creates some great abstractions but we are not really sure of the models and so are trying to figure out what they are from the code.
> 
> Can you offer any ideas for how we can more easily figure out what we need to do?.
> 
> There are the fluid docs, but as Alfredo pointed out the version of fluid described is inconsistent 
> 
> Hi all,
> 
> I mean the documentation is great but I think that you have to read in the correct order to understand it. As a begginer I tried to find how modify a kettle app, so first I went to https://github.com/fluid-project/kettle <https://github.com/fluid-project/kettle> , https://wiki.fluidproject.org/display/fluid/Kettle <https://wiki.fluidproject.org/display/fluid/Kettle> and https://wiki.gpii.net/index.php/Configuration <https://wiki.gpii.net/index.php/Configuration> , but I couldn't understand some chunks of code that are there. So then I realized about http://docs.fluidproject.org/ <http://docs.fluidproject.org/> where you can find the answers to all the previous documentation. Perhaps a heads up in the READMEs saying something like "Hey! check the fluid documentation out first!" could set the begginers in the correct path.
> 
> A similar case is found in UIOptions documentation. First I found this url when I searched some documentation: https://wiki.fluidproject.org/display/Infusion14/Tutorial+-+Full+Page+UI+Options <https://wiki.fluidproject.org/display/Infusion14/Tutorial+-+Full+Page+UI+Options> but there is also an updated section in docs.fluidproject.org <http://docs.fluidproject.org/>: http://docs.fluidproject.org/infusion/development/tutorial-userInterfaceOptions/UserInterfaceOptions.html <http://docs.fluidproject.org/infusion/development/tutorial-userInterfaceOptions/UserInterfaceOptions.html> that I found after some unsuccessful tests with the latest code.
> 
> Regards,
> 
> 
> Thanks
> 
> Steve Lee
> OpenDirective http://opendirective.com <http://opendirective.com/>
> 
> _______________________________________________
> Architecture mailing list
> Architecture at lists.gpii.net <mailto:Architecture at lists.gpii.net>
> http://lists.gpii.net/cgi-bin/mailman/listinfo/architecture <http://lists.gpii.net/cgi-bin/mailman/listinfo/architecture>
> 
> 
> 
> 
> -- 
> Alfredo
> _______________________________________________
> Architecture mailing list
> Architecture at lists.gpii.net
> http://lists.gpii.net/cgi-bin/mailman/listinfo/architecture

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20150618/35f9f8d8/attachment.html>


More information about the fluid-work mailing list