[infinispan-dev] Comments on tutorials etc.

[Pete Muir]

Yep, will apply all this if you are happy. Most of it is just stuff that could be a little better, not real problems ;-)

Do you guys track errors in docs in JIRA? If so, I will file an issue for the Groovy one.


On 18 Jan 2011, at 17:51, Manik Surtani wrote:

> Great feedback, Pete.  +1 to all suggestions here, I've added a few more notes inline with some of the points below.  Feel like making the changes you've suggested?
> 
> Galder, could you pls help with the Scala-related points?
> 
> Cheers
> Manik
> 
> 
> On 18 Jan 2011, at 16:17, Pete Muir wrote:
> 
>> As part of getting up to speed with infinispan, I've been running through the docs and tutorials. Some thoughts
>> 
>> 1) http://www.jboss.org/infinispan/downloads.html
> 
> +1, along with links to the Infinispan Maven wiki pages for more detailed info.  But definitely +1 for a quick-access copy-and-paste snippet.
> 
>> 2) http://www.jboss.org/infinispan/downloads.html
>> 
>> Suggest adding two code snippet for the dependency too:
> 
> +1 again.  This info is already up there, but +1 for easy to copy snippets.
> 
>> 3) http://community.jboss.org/wiki/5minutetutorialonInfinispan
>> 
>> Cache cache = manager.getCache();
> 
> There were issues with angle brackets on the wiki system, this may have been fixed now.  
>> 
>> 4) http://community.jboss.org/wiki/5minutetutorialonInfinispan
>> 
>> To make this totally fool proof, might want to indicate how people can run this, e.g. in a main method on a class. This also really highlights how "lightweight" this stuff is (no need for a big server etc.)
> 
>> 5) http://community.jboss.org/wiki/5minutetutorialonInfinispan
>> 
>> For the expiration, might want to adjust the values a bit. 60s is a long time to wait, and also setting the expiration to 60s, and the thread sleep to 60s is risking the assertion failing (it did for me). I would suggest something more like 5s expiration, 10s sleep.
>> 
>> 6) http://community.jboss.org/wiki/InstallingInfinispantutorialenvironment
>> 
>> This information is really useful, and I would suggest splitting out the groovy bit and then adding a link from the 5 min tutoiral
>> 
>> 7) http://community.jboss.org/wiki/InstallingInfinispantutorialenvironment
>> 
>> Some of the instructions on this page could be clearer if they all built as code blocks. For example, following the groovy ones, I struggled reading the first paragraph, it would have been helpful to split this up and provide code snippets to use like:
>> 
>> $> cp $INFINISPAN_HOME/infinispan-core.jar ~/.groovy/lib/
>> 
>> etc.
>> 
>> 8) http://community.jboss.org/wiki/InstallingInfinispantutorialenvironment
>> 
>> The location of infinispan-core jars and dependencies has changed from $INFNISPAN_HOME/modules/core to $INIFINISPAN_HOME, the tutorial needs updating
>> 
>> 9) http://community.jboss.org/wiki/Infinispaninteractivetutorial
>> 
>> When doing the below line, I get an error:
>> 
>> And now, create a cache manager indicating the file with the cache definitions.
>> groovy:000> manager = new DefaultCacheManager("sample-configurations.xml"
>> )
>> ===> org.infinispan.manager.DefaultCacheManager at 19cc1b@Address:
>> null
>> 
>> oovy:000> manager = new DefaultCacheManager("/Users/pmuir/Downloads/sample-configurations.xml")
>> ERROR java.io.IOException:
>> null
>>        at org.infinispan.config.InfinispanConfiguration.newInfinispanConfiguration (InfinispanConfiguration.java:264)
>>        at org.infinispan.config.InfinispanConfiguration.newInfinispanConfiguration (InfinispanConfiguration.java:282)
>>        at org.infinispan.config.InfinispanConfiguration.newInfinispanConfiguration (InfinispanConfiguration.java:136)
>>        at org.infinispan.manager.DefaultCacheManager.<init> (DefaultCacheManager.java:243)
>>        at org.infinispan.manager.DefaultCacheManager.<init> (DefaultCacheManager.java:229)
>>        at groovysh_evaluate.run (groovysh_evaluate:4)
>> 
>> and I don't know how to get past it, so I stopped this tutorial here.
> 
> Hmm, could be a missing schema?  Did you enable log4j TRACE level logging to see what was going on?
> 
>> 10) http://community.jboss.org/wiki/InfinispanInteractiveTutorialwithScala
>> 
>> Could do with some comments explaining what each line is doing, some of the code isn't self describing
>> 
>> e.g.
>> 
>> what does me entering val defaultCache = manager.getCache[String, String]() actually achieve?
>> 
> 
> Galder, care to look into this one?
> 
>> 11) http://community.jboss.org/wiki/InfinispanInteractiveTutorialwithScala
>> 
>> It might be neat to split up input and output e.g. into different snippets - make it easier to read
>> 
>> 12) http://community.jboss.org/wiki/InfinispanInteractiveTutorialwithScala
>> 
>> For "Cache with Transaction Management" I was not seeing TX semantics being obeyed, I saw the size increment as a added key-value pairs
> 
> Galder, this as well?
> 
>> 13) http://community.jboss.org/wiki/SettingupanInfinispanCluster
>> 
>> When I do gc.setTransportClass(JGroupsTransport.class.getName()); and import JGroupsTransport I get two options, one from Infinispan and one from JGroups, tutorial should saw which to import.
> 
> It should be the Infinispan one - the fully qualified classname can be seen in the next XML snippet.  Maybe the Java snippet should use the fqcn as well.
> 
> 
>> 14) http://community.jboss.org/wiki/SettingupanInfinispanCluster
>> 
>> The CacheManager is deprecated, I guess these needs updating to 4.2 API?
> 
> Yes.
> 
>> 
>> 15) http://community.jboss.org/wiki/SettingupanInfinispanCluster
>> 
>> I would suggest adding some instructions about how to do a simple test to see the cluster working, atm the tutorial seems to end in middle of something. There are hints in the comment, but nothing concrete
> 
> Perhaps starting 2 nodes using main() methods, in different terminals, and reverting back to the 5-min tutorial trying stuff on alternate instances?
> 
> Cheers
> Manik
> --
> Manik Surtani
> manik at jboss.org
> twitter.com/maniksurtani
> 
> Lead, Infinispan
> http://www.infinispan.org
> 
> 
> 
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev