You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@river.apache.org by Greg Trasuk <tr...@stratuscom.com> on 2015/02/07 15:27:48 UTC
River-examples project
Hi all:
This doesn’t seem to have gone through the mail system yesterday, so I’m posting again. Apologies if we eventually have a storm of similar messages.
Hi all:
Finally finished the examples project. Please review and comment.
You can get it from svn at https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
My thinking is that a new user trying out the examples will start with the read me file at: “README.md” (formatted as markdown
so that in case someone is looking at the github mirror, they’ll see it on the front page of the project). So, if one or more of you could checkout the project and begin by following the README.md instructions, that would give us a feel for the “new-user” experience.
I’m picturing that we should be able to release the examples project fairly quickly, and then start trying to publicize it. Also, we can add more advanced examples as time goes on (e.g. event notifications, transactions, JavaSpaces, web app client, etc).
Thanks,
Greg Trasuk.
Re: River-examples project - followup
Posted by Greg Trasuk <tr...@stratuscom.com>.
Hi all:
Just coming back to the examples project mentioned below… Pat provided good feedback on the formatting and content of the tutorial - Did anyone else get a chance to look at it? I’d love to see if we can release it in the next week or two.
Cheers,
Greg Trasuk.
On Feb 7, 2015, at 9:27 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
> Hi all:
>
> This doesn’t seem to have gone through the mail system yesterday, so I’m posting again. Apologies if we eventually have a storm of similar messages.
>
> Hi all:
>
> Finally finished the examples project. Please review and comment.
>
> You can get it from svn at https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>
> My thinking is that a new user trying out the examples will start with the read me file at: “README.md” (formatted as markdown
> so that in case someone is looking at the github mirror, they’ll see it on the front page of the project). So, if one or more of you could checkout the project and begin by following the README.md instructions, that would give us a feel for the “new-user” experience.
>
> I’m picturing that we should be able to release the examples project fairly quickly, and then start trying to publicize it. Also, we can add more advanced examples as time goes on (e.g. event notifications, transactions, JavaSpaces, web app client, etc).
>
> Thanks,
>
> Greg Trasuk.
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
Found the problem - it isn’t Cygwin-related, it’s Windows-related. The class path separator character is different on Windows vs OSX, so the service-starter config files need to use File.pathSeparator rather than hardcode the character.
I’ve committed the change, so you should be able to update from subversion (right-click on the ‘home’ project and select ‘Subversion -> Update -> Update to HEAD’, and rebuild, then you should be able to run the command lines in Cygwin.
Cheers,
Greg Trasuk
On Feb 8, 2015, at 10:56 PM, Patricia Shanahan <pa...@acm.org> wrote:
> First of all, I must say I am very impressed with the tutorial chain in
> the examples HTML files. I am currently skimming it, in order to try out
> running things, but will go back and reread in much more detail.
>
> I have been running the command line operations in a Cygwin shell. I
> have to add an "&" at the end of each line to get control back after
> starting something.
>
> All was well until I tried to start the hello service. At that point, I
> got an exception. It is probably related to Cygwin's file naming. What
> is the recommended way of running these commands on a Windows machine?
> The syntax does not look like Microsoft command tool.
>
> Here is the exception:
>
> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
> $ java -Djava.security.manager -Djava.security.policy=server.policy -Djava.rmi.server.useCodebaseOnly=false -jar lib/start.jar start-hello-service.config &
> [3] 14212
>
> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
> $ Feb 08, 2015 7:49:37 PM com.sun.jini.tool.ClassServer run
> INFO: ClassServer started [[lib-dl\], port 8090]
> Feb 08, 2015 7:49:37 PM com.sun.jini.start.NonActivatableServiceDescriptor create
> SEVERE: classloader.problem
> Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter checkResultFailures
> WARNING: Exception creating service.
> java.io.IOException: The filename, directory name, or volume label syntax is incorrect
> at java.io.WinNTFileSystem.canonicalize0(Native Method)
> at java.io.WinNTFileSystem.canonicalize(Unknown Source)
> at java.io.File.getCanonicalPath(Unknown Source)
> at java.io.File.getCanonicalFile(Unknown Source)
> at com.sun.jini.start.ClassLoaderUtil.getClasspathURLs(ClassLoaderUtil.java:77)
> at com.sun.jini.start.ClassLoaderUtil.getImportCodebaseURLs(ClassLoaderUtil.java:135)
> at com.sun.jini.start.NonActivatableServiceDescriptor.create(NonActivatableServiceDescriptor.java:598)
> at com.sun.jini.start.ServiceStarter.create(ServiceStarter.java:287)
> at com.sun.jini.start.ServiceStarter.processServiceDescriptors(ServiceStarter.java:445)
> at com.sun.jini.start.ServiceStarter.main(ServiceStarter.java:476)
>
> Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter checkResultFailures
> WARNING: Associated service descriptor [1]: [http://192.168.1.113:8090/hello-api.jar, server.policy, lib\hello-api.jar:lib\hello-service.jar, org.apache.river.examples.hello.service.GreeterService, [hello-service.config], com.sun.jini.start.NonActivatableServiceDescriptor$1@443b7951, BasicProxyPreparer[]]
>
>
> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
> $
Re: River-examples project
Posted by Peter <ji...@zeus.net.au>.
Earlier releases of River have issues with spaces in path names and also with syntax around drive letters that can cause test failures in the qa test suite.
If you're interested to learn more, have a look at org.apache.river.api.net.Uri.
----- Original message -----
>
> On Feb 9, 2015, at 5:08 AM, Peter Firmstone <ji...@zeus.net.au> wrote:
>
> > The qa-refactor build fully supports Windows file paths, so Window's
> > users won't need cigwin when it's eventually released.
> >
>
> Cygwin is there because people like the Unix command line, not because
> Java doesn’t work.
>
> > I was thinking it might help the experience for new users if we can
> > move all examples into their own build and distribution, so that users
> > aren't distracted by the main build?
> >
>
> That’s what the river-examples project is doing.
>
> > Regards,
> >
> > Peter.
> >
> > On 9/02/2015 4:55 PM, Patricia Shanahan wrote:
> > > On 2/8/2015 10:30 PM, Greg Trasuk wrote:
> > > >
> > > > Auto-correct apparently doesn’t recognize “jvm” and changed it to
> > > > “jam” below :-)
> > >
> > > The only good auto-correct is a disabled auto-correct.
> > >
> > > >
> > > > Greg Trasuk.
> > > >
> > > > On Feb 9, 2015, at 1:22 AM, Greg Trasuk <tr...@stratuscom.com>
> > > > wrote:
> > > >
> > > > >
> > > > > By the way, the command lines are just invoking the jam, so the
> > > > > exact same command line should work in Windows command shell.
> > > > > But you’re right, we should have explicit Windows instructions
> > > > > in the tutorial as well.
> > > > >
> > >
> > > I'll carry on using Cygwin, which now does start the hello Greeter
> > > service, and then go back and repeat the trail using a Windows
> > > command tool. Ideally, both will work and we can give new users
> > > their choice.
> > >
> > > Thanks for the quick fix.
> > >
> > > Patricia
> >
>
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
On Feb 9, 2015, at 5:08 AM, Peter Firmstone <ji...@zeus.net.au> wrote:
> The qa-refactor build fully supports Windows file paths, so Window's users won't need cigwin when it's eventually released.
>
Cygwin is there because people like the Unix command line, not because Java doesn’t work.
> I was thinking it might help the experience for new users if we can move all examples into their own build and distribution, so that users aren't distracted by the main build?
>
That’s what the river-examples project is doing.
> Regards,
>
> Peter.
>
> On 9/02/2015 4:55 PM, Patricia Shanahan wrote:
>> On 2/8/2015 10:30 PM, Greg Trasuk wrote:
>>>
>>> Auto-correct apparently doesn’t recognize “jvm” and changed it to “jam” below :-)
>>
>> The only good auto-correct is a disabled auto-correct.
>>
>>>
>>> Greg Trasuk.
>>>
>>> On Feb 9, 2015, at 1:22 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>>
>>>>
>>>> By the way, the command lines are just invoking the jam, so the exact same command line should work in Windows command shell. But you’re right, we should have explicit Windows instructions in the tutorial as well.
>>>>
>>
>> I'll carry on using Cygwin, which now does start the hello Greeter service, and then go back and repeat the trail using a Windows command tool. Ideally, both will work and we can give new users their choice.
>>
>> Thanks for the quick fix.
>>
>> Patricia
>
Re: River-examples project
Posted by Peter Firmstone <ji...@zeus.net.au>.
The qa-refactor build fully supports Windows file paths, so Window's
users won't need cigwin when it's eventually released.
I was thinking it might help the experience for new users if we can move
all examples into their own build and distribution, so that users aren't
distracted by the main build?
Regards,
Peter.
On 9/02/2015 4:55 PM, Patricia Shanahan wrote:
> On 2/8/2015 10:30 PM, Greg Trasuk wrote:
>>
>> Auto-correct apparently doesn’t recognize “jvm” and changed it to
>> “jam” below :-)
>
> The only good auto-correct is a disabled auto-correct.
>
>>
>> Greg Trasuk.
>>
>> On Feb 9, 2015, at 1:22 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>
>>>
>>> By the way, the command lines are just invoking the jam, so the
>>> exact same command line should work in Windows command shell. But
>>> you’re right, we should have explicit Windows instructions in the
>>> tutorial as well.
>>>
>
> I'll carry on using Cygwin, which now does start the hello Greeter
> service, and then go back and repeat the trail using a Windows command
> tool. Ideally, both will work and we can give new users their choice.
>
> Thanks for the quick fix.
>
> Patricia
Re: River-examples project
Posted by Patricia Shanahan <pa...@acm.org>.
As a general formatting suggestion, use two different box borders for
two different types of code boxes:
1. Code that you are discussing that is actually present in the site,
and does not need to be entered by the user.
2. Commands the user should enter in a shell.
Re: River-examples project
Posted by Patricia Shanahan <pa...@acm.org>.
On 2/8/2015 10:30 PM, Greg Trasuk wrote:
>
> Auto-correct apparently doesn’t recognize “jvm” and changed it to “jam” below :-)
The only good auto-correct is a disabled auto-correct.
>
> Greg Trasuk.
>
> On Feb 9, 2015, at 1:22 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>
>>
>> By the way, the command lines are just invoking the jam, so the exact same command line should work in Windows command shell. But you’re right, we should have explicit Windows instructions in the tutorial as well.
>>
I'll carry on using Cygwin, which now does start the hello Greeter
service, and then go back and repeat the trail using a Windows command
tool. Ideally, both will work and we can give new users their choice.
Thanks for the quick fix.
Patricia
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
Auto-correct apparently doesn’t recognize “jvm” and changed it to “jam” below :-)
Greg Trasuk.
On Feb 9, 2015, at 1:22 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>
> By the way, the command lines are just invoking the jam, so the exact same command line should work in Windows command shell. But you’re right, we should have explicit Windows instructions in the tutorial as well.
>
> Cheers,
>
> Greg Trasuk
>
> On Feb 8, 2015, at 10:56 PM, Patricia Shanahan <pa...@acm.org> wrote:
>
>> First of all, I must say I am very impressed with the tutorial chain in
>> the examples HTML files. I am currently skimming it, in order to try out
>> running things, but will go back and reread in much more detail.
>>
>> I have been running the command line operations in a Cygwin shell. I
>> have to add an "&" at the end of each line to get control back after
>> starting something.
>>
>> All was well until I tried to start the hello service. At that point, I
>> got an exception. It is probably related to Cygwin's file naming. What
>> is the recommended way of running these commands on a Windows machine?
>> The syntax does not look like Microsoft command tool.
>>
>> Here is the exception:
>>
>> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
>> $ java -Djava.security.manager -Djava.security.policy=server.policy -Djava.rmi.server.useCodebaseOnly=false -jar lib/start.jar start-hello-service.config &
>> [3] 14212
>>
>> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
>> $ Feb 08, 2015 7:49:37 PM com.sun.jini.tool.ClassServer run
>> INFO: ClassServer started [[lib-dl\], port 8090]
>> Feb 08, 2015 7:49:37 PM com.sun.jini.start.NonActivatableServiceDescriptor create
>> SEVERE: classloader.problem
>> Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter checkResultFailures
>> WARNING: Exception creating service.
>> java.io.IOException: The filename, directory name, or volume label syntax is incorrect
>> at java.io.WinNTFileSystem.canonicalize0(Native Method)
>> at java.io.WinNTFileSystem.canonicalize(Unknown Source)
>> at java.io.File.getCanonicalPath(Unknown Source)
>> at java.io.File.getCanonicalFile(Unknown Source)
>> at com.sun.jini.start.ClassLoaderUtil.getClasspathURLs(ClassLoaderUtil.java:77)
>> at com.sun.jini.start.ClassLoaderUtil.getImportCodebaseURLs(ClassLoaderUtil.java:135)
>> at com.sun.jini.start.NonActivatableServiceDescriptor.create(NonActivatableServiceDescriptor.java:598)
>> at com.sun.jini.start.ServiceStarter.create(ServiceStarter.java:287)
>> at com.sun.jini.start.ServiceStarter.processServiceDescriptors(ServiceStarter.java:445)
>> at com.sun.jini.start.ServiceStarter.main(ServiceStarter.java:476)
>>
>> Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter checkResultFailures
>> WARNING: Associated service descriptor [1]: [http://192.168.1.113:8090/hello-api.jar, server.policy, lib\hello-api.jar:lib\hello-service.jar, org.apache.river.examples.hello.service.GreeterService, [hello-service.config], com.sun.jini.start.NonActivatableServiceDescriptor$1@443b7951, BasicProxyPreparer[]]
>>
>>
>> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
>> $
>
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
By the way, the command lines are just invoking the jam, so the exact same command line should work in Windows command shell. But you’re right, we should have explicit Windows instructions in the tutorial as well.
Cheers,
Greg Trasuk
On Feb 8, 2015, at 10:56 PM, Patricia Shanahan <pa...@acm.org> wrote:
> First of all, I must say I am very impressed with the tutorial chain in
> the examples HTML files. I am currently skimming it, in order to try out
> running things, but will go back and reread in much more detail.
>
> I have been running the command line operations in a Cygwin shell. I
> have to add an "&" at the end of each line to get control back after
> starting something.
>
> All was well until I tried to start the hello service. At that point, I
> got an exception. It is probably related to Cygwin's file naming. What
> is the recommended way of running these commands on a Windows machine?
> The syntax does not look like Microsoft command tool.
>
> Here is the exception:
>
> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
> $ java -Djava.security.manager -Djava.security.policy=server.policy -Djava.rmi.server.useCodebaseOnly=false -jar lib/start.jar start-hello-service.config &
> [3] 14212
>
> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
> $ Feb 08, 2015 7:49:37 PM com.sun.jini.tool.ClassServer run
> INFO: ClassServer started [[lib-dl\], port 8090]
> Feb 08, 2015 7:49:37 PM com.sun.jini.start.NonActivatableServiceDescriptor create
> SEVERE: classloader.problem
> Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter checkResultFailures
> WARNING: Exception creating service.
> java.io.IOException: The filename, directory name, or volume label syntax is incorrect
> at java.io.WinNTFileSystem.canonicalize0(Native Method)
> at java.io.WinNTFileSystem.canonicalize(Unknown Source)
> at java.io.File.getCanonicalPath(Unknown Source)
> at java.io.File.getCanonicalFile(Unknown Source)
> at com.sun.jini.start.ClassLoaderUtil.getClasspathURLs(ClassLoaderUtil.java:77)
> at com.sun.jini.start.ClassLoaderUtil.getImportCodebaseURLs(ClassLoaderUtil.java:135)
> at com.sun.jini.start.NonActivatableServiceDescriptor.create(NonActivatableServiceDescriptor.java:598)
> at com.sun.jini.start.ServiceStarter.create(ServiceStarter.java:287)
> at com.sun.jini.start.ServiceStarter.processServiceDescriptors(ServiceStarter.java:445)
> at com.sun.jini.start.ServiceStarter.main(ServiceStarter.java:476)
>
> Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter checkResultFailures
> WARNING: Associated service descriptor [1]: [http://192.168.1.113:8090/hello-api.jar, server.policy, lib\hello-api.jar:lib\hello-service.jar, org.apache.river.examples.hello.service.GreeterService, [hello-service.config], com.sun.jini.start.NonActivatableServiceDescriptor$1@443b7951, BasicProxyPreparer[]]
>
>
> Patricia@Jan2014Desktop /cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
> $
Re: River-examples project
Posted by Patricia Shanahan <pa...@acm.org>.
First of all, I must say I am very impressed with the tutorial chain in
the examples HTML files. I am currently skimming it, in order to try out
running things, but will go back and reread in much more detail.
I have been running the command line operations in a Cygwin shell. I
have to add an "&" at the end of each line to get control back after
starting something.
All was well until I tried to start the hello service. At that point, I
got an exception. It is probably related to Cygwin's file naming. What
is the recommended way of running these commands on a Windows machine?
The syntax does not look like Microsoft command tool.
Here is the exception:
Patricia@Jan2014Desktop
/cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
$ java -Djava.security.manager -Djava.security.policy=server.policy
-Djava.rmi.server.useCodebaseOnly=false -jar lib/start.jar
start-hello-service.config &
[3] 14212
Patricia@Jan2014Desktop
/cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
$ Feb 08, 2015 7:49:37 PM com.sun.jini.tool.ClassServer run
INFO: ClassServer started [[lib-dl\], port 8090]
Feb 08, 2015 7:49:37 PM
com.sun.jini.start.NonActivatableServiceDescriptor create
SEVERE: classloader.problem
Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter
checkResultFailures
WARNING: Exception creating service.
java.io.IOException: The filename, directory name, or volume label
syntax is incorrect
at java.io.WinNTFileSystem.canonicalize0(Native Method)
at java.io.WinNTFileSystem.canonicalize(Unknown Source)
at java.io.File.getCanonicalPath(Unknown Source)
at java.io.File.getCanonicalFile(Unknown Source)
at
com.sun.jini.start.ClassLoaderUtil.getClasspathURLs(ClassLoaderUtil.java:77)
at
com.sun.jini.start.ClassLoaderUtil.getImportCodebaseURLs(ClassLoaderUtil.java:135)
at
com.sun.jini.start.NonActivatableServiceDescriptor.create(NonActivatableServiceDescriptor.java:598)
at
com.sun.jini.start.ServiceStarter.create(ServiceStarter.java:287)
at
com.sun.jini.start.ServiceStarter.processServiceDescriptors(ServiceStarter.java:445)
at com.sun.jini.start.ServiceStarter.main(ServiceStarter.java:476)
Feb 08, 2015 7:49:37 PM com.sun.jini.start.ServiceStarter
checkResultFailures
WARNING: Associated service descriptor [1]:
[http://192.168.1.113:8090/hello-api.jar, server.policy,
lib\hello-api.jar:lib\hello-service.jar,
org.apache.river.examples.hello.service.GreeterService,
[hello-service.config],
com.sun.jini.start.NonActivatableServiceDescriptor$1@443b7951,
BasicProxyPreparer[]]
Patricia@Jan2014Desktop
/cygdrive/c/river-examples/home/target/home-1.0-SNAPSHOT-bin
$
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
If you feel confident about a change to the examples, feel free to edit the files and commit it.
Otherwise, or if you’re making general suggestions, we may as well just reply to this thread and I’ll collect the required changes later.
Cheers,
Greg Trasuk.
On Feb 8, 2015, at 9:40 PM, Patricia Shanahan <pa...@acm.org> wrote:
> On a meta-issue, should we be editing the results and ideas into a file in SVN, or plan to review these threads later?
>
> I hope we can end up with full, well-tested instructions for a few different environments.
>
> On 2/8/2015 7:48 AM, Greg Trasuk wrote:
>>
>> Thanks for trying this out… Some answers below…
>>
>> Cheers,
>>
>> Greg Trasuk
>>
>> On Feb 8, 2015, at 4:33 AM, Patricia Shanahan <pa...@acm.org> wrote:
>>
>>> Thanks very much for getting this done.
>>>
>>> I am playing naive new user. I checked out the svn files, and viewed
>>> README.md. Note that it might be nice to provide it as a README.txt as
>>> well - a user who is getting the code from SVN may not be familiar with
>>> Github conventions.
>>>
>>
>> I was thinking that README.anything was likely to get the user’s first attention, and that the md text was still readable as text. But I see your point - it’s trivial to include a README.txt as well.
>>
>>
>>> I think the instructions need a bit more information:
>>>
>>> "To build the examples, simply unpack the source distribution of
>>> 'river-examples',
>>> and then,
>>>
>>> cd river-examples
>>> mvn install
>>> mvn site"
>>>
>>> What am I supposed to unpack? How do I unpack it?
>>>
>>
>> Instructions need clarification here - you pulled it from cvs, so it’s not “the source distribution”,
>
> which would have been in a “.tgz” file.
>>
>
> Actually SVN, not CVS, but same principle.
>
> A readme file should assume the user reads it at the first point at which the readme becomes accessible, no earlier. Is the readme going to be inside the .tgz, or outside it? What is a .tgz?
>
>
>>> It should say where to type this. Windows command tool? Cygwin shell?
>>> Unix/Linux shell? I assume I need a JDK, but that should be specified.
>>> Which JDK versions?
>>>
>>> I skipped the "unpack" part of the instructions and used Netbeans. I
>>> created a new Maven project from existing POM, and built it. I then used
>>> right click on project, Custom, Goals to run "install" and "site". That
>>> all worked fine, including smoothly downloading from Maven Central.
>>>
>>> I opened the index.html file that resulted. Clicking on e.g. the
>>> "browser" link got "Firefox can't find the file at
>>> /C:/river-examples/target/site/browser/index.html.". The browser
>>> directory contains a file "browser-start.png" but no "index.html”.
>>
>> Ahh… Need for more instructions here. Netbeans bundles an older version of Maven that doesn’t understand Markdown text in the site generation. What you need to do is install the latest Maven from ‘maven.apache.org’ and configure Netbeans to use it. I’ll add a note to the instructions (although this is really Maven setup). For your immediate use,
>>
>> - Download Maven 3.2.5 from http://maven.apache.org/download.cgi. If you’re on Windows, download the zip file. If on Linux/Unix, get the “.tar.gz”.
>> - Unpack it to a convenient directory (Windows: right-click on the zip and select “Extract all”. OSX: Just open the tar.gz file. *nix: should be something like ‘tar xvzf apache-maven-3.2.5.bin.tar.gz /usr/local/apache-maven-3.2.5
>> - In Netbeans, select Preferences (OSX: Netbeans —> Preferences. Windows: Tools —> Options) then select the “Maven” tab) and then set the Maven Home field to point to your local installation.
>>
>
> For Windows, it is Tools -> Option ->Java -> Maven
>
>> Then, I suspect you’ll need to do a Custom —> clean install site.
>
> Did that, followed by the "install" and "site" goals. There were several warnings. Would you like the console output, or are they expected?
>
>>
>> I suppose the smart thing to do is just publish the examples documentation
>
> to the River Web site when we release it -that would replace the “Getting started” page.
>>
>
> Yes, I see the end point of this exercise as a much better "Getting started" page.
>
>>
>>>
>>
>>> Thanks again for your efforts.
>>>
>>> Patricia
>>>
>>> On 2/7/2015 6:27 AM, Greg Trasuk wrote:
>>>> Hi all:
>>>>
>>>> This doesn’t seem to have gone through the mail system yesterday, so
>>>> I’m posting again. Apologies if we eventually have a storm of
>>>> similar messages.
>>>>
>>>> Hi all:
>>>>
>>>> Finally finished the examples project. Please review and comment.
>>>>
>>>> You can get it from svn at
>>>> https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>>>>
>>>> My thinking is that a new user trying out the examples will start
>>>> with the read me file at: “README.md” (formatted as markdown so that
>>>> in case someone is looking at the github mirror, they’ll see it on
>>>> the front page of the project). So, if one or more of you could
>>>> checkout the project and begin by following the README.md
>>>> instructions, that would give us a feel for the “new-user”
>>>> experience.
>>>>
>>>> I’m picturing that we should be able to release the examples project
>>>> fairly quickly, and then start trying to publicize it. Also, we can
>>>> add more advanced examples as time goes on (e.g. event notifications,
>>>> transactions, JavaSpaces, web app client, etc).
>>>>
>>>> Thanks,
>>>>
>>>> Greg Trasuk.
Re: River-examples project
Posted by Patricia Shanahan <pa...@acm.org>.
On a meta-issue, should we be editing the results and ideas into a file
in SVN, or plan to review these threads later?
I hope we can end up with full, well-tested instructions for a few
different environments.
On 2/8/2015 7:48 AM, Greg Trasuk wrote:
>
> Thanks for trying this out… Some answers below…
>
> Cheers,
>
> Greg Trasuk
>
> On Feb 8, 2015, at 4:33 AM, Patricia Shanahan <pa...@acm.org> wrote:
>
>> Thanks very much for getting this done.
>>
>> I am playing naive new user. I checked out the svn files, and viewed
>> README.md. Note that it might be nice to provide it as a README.txt as
>> well - a user who is getting the code from SVN may not be familiar with
>> Github conventions.
>>
>
> I was thinking that README.anything was likely to get the user’s first attention, and that the md text was still readable as text. But I see your point - it’s trivial to include a README.txt as well.
>
>
>> I think the instructions need a bit more information:
>>
>> "To build the examples, simply unpack the source distribution of
>> 'river-examples',
>> and then,
>>
>> cd river-examples
>> mvn install
>> mvn site"
>>
>> What am I supposed to unpack? How do I unpack it?
>>
>
> Instructions need clarification here - you pulled it from cvs, so it’s not “the source distribution”,
which would have been in a “.tgz” file.
>
Actually SVN, not CVS, but same principle.
A readme file should assume the user reads it at the first point at
which the readme becomes accessible, no earlier. Is the readme going to
be inside the .tgz, or outside it? What is a .tgz?
>> It should say where to type this. Windows command tool? Cygwin shell?
>> Unix/Linux shell? I assume I need a JDK, but that should be specified.
>> Which JDK versions?
>>
>> I skipped the "unpack" part of the instructions and used Netbeans. I
>> created a new Maven project from existing POM, and built it. I then used
>> right click on project, Custom, Goals to run "install" and "site". That
>> all worked fine, including smoothly downloading from Maven Central.
>>
>> I opened the index.html file that resulted. Clicking on e.g. the
>> "browser" link got "Firefox can't find the file at
>> /C:/river-examples/target/site/browser/index.html.". The browser
>> directory contains a file "browser-start.png" but no "index.html”.
>
> Ahh… Need for more instructions here. Netbeans bundles an older version of Maven that doesn’t understand Markdown text in the site generation. What you need to do is install the latest Maven from ‘maven.apache.org’ and configure Netbeans to use it. I’ll add a note to the instructions (although this is really Maven setup). For your immediate use,
>
> - Download Maven 3.2.5 from http://maven.apache.org/download.cgi. If you’re on Windows, download the zip file. If on Linux/Unix, get the “.tar.gz”.
> - Unpack it to a convenient directory (Windows: right-click on the zip and select “Extract all”. OSX: Just open the tar.gz file. *nix: should be something like ‘tar xvzf apache-maven-3.2.5.bin.tar.gz /usr/local/apache-maven-3.2.5
> - In Netbeans, select Preferences (OSX: Netbeans —> Preferences. Windows: Tools —> Options) then select the “Maven” tab) and then set the Maven Home field to point to your local installation.
>
For Windows, it is Tools -> Option ->Java -> Maven
> Then, I suspect you’ll need to do a Custom —> clean install site.
Did that, followed by the "install" and "site" goals. There were several
warnings. Would you like the console output, or are they expected?
>
> I suppose the smart thing to do is just publish the examples documentation
to the River Web site when we release it -that would replace the
“Getting started” page.
>
Yes, I see the end point of this exercise as a much better "Getting
started" page.
>
>>
>
>> Thanks again for your efforts.
>>
>> Patricia
>>
>> On 2/7/2015 6:27 AM, Greg Trasuk wrote:
>>> Hi all:
>>>
>>> This doesn’t seem to have gone through the mail system yesterday, so
>>> I’m posting again. Apologies if we eventually have a storm of
>>> similar messages.
>>>
>>> Hi all:
>>>
>>> Finally finished the examples project. Please review and comment.
>>>
>>> You can get it from svn at
>>> https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>>>
>>> My thinking is that a new user trying out the examples will start
>>> with the read me file at: “README.md” (formatted as markdown so that
>>> in case someone is looking at the github mirror, they’ll see it on
>>> the front page of the project). So, if one or more of you could
>>> checkout the project and begin by following the README.md
>>> instructions, that would give us a feel for the “new-user”
>>> experience.
>>>
>>> I’m picturing that we should be able to release the examples project
>>> fairly quickly, and then start trying to publicize it. Also, we can
>>> add more advanced examples as time goes on (e.g. event notifications,
>>> transactions, JavaSpaces, web app client, etc).
>>>
>>> Thanks,
>>>
>>> Greg Trasuk.
>>>
>
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
Thanks for trying this out… Some answers below…
Cheers,
Greg Trasuk
On Feb 8, 2015, at 4:33 AM, Patricia Shanahan <pa...@acm.org> wrote:
> Thanks very much for getting this done.
>
> I am playing naive new user. I checked out the svn files, and viewed
> README.md. Note that it might be nice to provide it as a README.txt as
> well - a user who is getting the code from SVN may not be familiar with
> Github conventions.
>
I was thinking that README.anything was likely to get the user’s first attention, and that the md text was still readable as text. But I see your point - it’s trivial to include a README.txt as well.
> I think the instructions need a bit more information:
>
> "To build the examples, simply unpack the source distribution of
> 'river-examples',
> and then,
>
> cd river-examples
> mvn install
> mvn site"
>
> What am I supposed to unpack? How do I unpack it?
>
Instructions need clarification here - you pulled it from cvs, so it’s not “the source distribution”, which would have been in a “.tgz” file.
> It should say where to type this. Windows command tool? Cygwin shell?
> Unix/Linux shell? I assume I need a JDK, but that should be specified.
> Which JDK versions?
>
> I skipped the "unpack" part of the instructions and used Netbeans. I
> created a new Maven project from existing POM, and built it. I then used
> right click on project, Custom, Goals to run "install" and "site". That
> all worked fine, including smoothly downloading from Maven Central.
>
> I opened the index.html file that resulted. Clicking on e.g. the
> "browser" link got "Firefox can't find the file at
> /C:/river-examples/target/site/browser/index.html.". The browser
> directory contains a file "browser-start.png" but no "index.html”.
Ahh… Need for more instructions here. Netbeans bundles an older version of Maven that doesn’t understand Markdown text in the site generation. What you need to do is install the latest Maven from ‘maven.apache.org’ and configure Netbeans to use it. I’ll add a note to the instructions (although this is really Maven setup). For your immediate use,
- Download Maven 3.2.5 from http://maven.apache.org/download.cgi. If you’re on Windows, download the zip file. If on Linux/Unix, get the “.tar.gz”.
- Unpack it to a convenient directory (Windows: right-click on the zip and select “Extract all”. OSX: Just open the tar.gz file. *nix: should be something like ‘tar xvzf apache-maven-3.2.5.bin.tar.gz /usr/local/apache-maven-3.2.5
- In Netbeans, select Preferences (OSX: Netbeans —> Preferences. Windows: Tools —> Options) then select the “Maven” tab) and then set the Maven Home field to point to your local installation.
Then, I suspect you’ll need to do a Custom —> clean install site.
I suppose the smart thing to do is just publish the examples documentation to the River Web site when we release it -that would replace the “Getting started” page.
>
> Thanks again for your efforts.
>
> Patricia
>
> On 2/7/2015 6:27 AM, Greg Trasuk wrote:
>> Hi all:
>>
>> This doesn’t seem to have gone through the mail system yesterday, so
>> I’m posting again. Apologies if we eventually have a storm of
>> similar messages.
>>
>> Hi all:
>>
>> Finally finished the examples project. Please review and comment.
>>
>> You can get it from svn at
>> https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>>
>> My thinking is that a new user trying out the examples will start
>> with the read me file at: “README.md” (formatted as markdown so that
>> in case someone is looking at the github mirror, they’ll see it on
>> the front page of the project). So, if one or more of you could
>> checkout the project and begin by following the README.md
>> instructions, that would give us a feel for the “new-user”
>> experience.
>>
>> I’m picturing that we should be able to release the examples project
>> fairly quickly, and then start trying to publicize it. Also, we can
>> add more advanced examples as time goes on (e.g. event notifications,
>> transactions, JavaSpaces, web app client, etc).
>>
>> Thanks,
>>
>> Greg Trasuk.
>>
Re: River-examples project
Posted by Patricia Shanahan <pa...@acm.org>.
Thanks very much for getting this done.
I am playing naive new user. I checked out the svn files, and viewed
README.md. Note that it might be nice to provide it as a README.txt as
well - a user who is getting the code from SVN may not be familiar with
Github conventions.
I think the instructions need a bit more information:
"To build the examples, simply unpack the source distribution of
'river-examples',
and then,
cd river-examples
mvn install
mvn site"
What am I supposed to unpack? How do I unpack it?
It should say where to type this. Windows command tool? Cygwin shell?
Unix/Linux shell? I assume I need a JDK, but that should be specified.
Which JDK versions?
I skipped the "unpack" part of the instructions and used Netbeans. I
created a new Maven project from existing POM, and built it. I then used
right click on project, Custom, Goals to run "install" and "site". That
all worked fine, including smoothly downloading from Maven Central.
I opened the index.html file that resulted. Clicking on e.g. the
"browser" link got "Firefox can't find the file at
/C:/river-examples/target/site/browser/index.html.". The browser
directory contains a file "browser-start.png" but no "index.html".
Thanks again for your efforts.
Patricia
On 2/7/2015 6:27 AM, Greg Trasuk wrote:
> Hi all:
>
> This doesn’t seem to have gone through the mail system yesterday, so
> I’m posting again. Apologies if we eventually have a storm of
> similar messages.
>
> Hi all:
>
> Finally finished the examples project. Please review and comment.
>
> You can get it from svn at
> https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>
> My thinking is that a new user trying out the examples will start
> with the read me file at: “README.md” (formatted as markdown so that
> in case someone is looking at the github mirror, they’ll see it on
> the front page of the project). So, if one or more of you could
> checkout the project and begin by following the README.md
> instructions, that would give us a feel for the “new-user”
> experience.
>
> I’m picturing that we should be able to release the examples project
> fairly quickly, and then start trying to publicize it. Also, we can
> add more advanced examples as time goes on (e.g. event notifications,
> transactions, JavaSpaces, web app client, etc).
>
> Thanks,
>
> Greg Trasuk.
>
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
Works for me. I’ve removed it from cvs.
Currently, I’m working on an example that shows how to access Jini services from within a JEE 6 application in Apache TomEE. Once that’s done I’d like to release the project and replace the current “Getting started” page with the examples instructions.
Also, I’d like to include a JavaSpaces example - does someone have one handy, or at least some ideas?
Cheers,
Greg Trasuk.
> On Jul 2, 2015, at 9:23 AM, Patricia Shanahan <pa...@acm.org> wrote:
>
> I think either remove it completely, or if it has value in other contexts move it to a separate folder with a description explaining its use.
>
> On 7/1/2015 9:17 PM, Jean Cote wrote:
>> I think it should be removed to prevent confusion.
>>
>> Sent from my iPod
>>
>>> On Jul 1, 2015, at 2:49 PM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>>
>>>
>>> It’s a hold-over from the old examples folder that I started with. It starts up an http server that serves out the contents of the ‘lib-dl’ folder. In the older examples in the JTSK, the pattern was to start up the class server separately. In the new examples that I did, both the 'start-infra.config’ and ’start-hello-service.config’ files include entries to start their own class servers, so they are independent (if you look carefully, you’ll see that they specify different ports for the http server).
>>>
>>> So you’re right, the ‘start-class-server.config’ file is not used in the examples instructions, although it might be useful as an example of what entries to include in a starter configuration file. I’d be interested in opinions as to whether we should just take it out of the new examples project.
>>>
>>> Cheers,
>>>
>>> Greg Trasuk
>>>
>>>> On Jul 1, 2015, at 2:59 PM, Jean Cote <je...@gmail.com> wrote:
>>>>
>>>> Greg
>>>>
>>>> Thanks for doing this. It is very useful.
>>>> There is a file called 'start-class-server.config' that doesn't seem to have any use. Any clue why you created it?
>>>>
>>>> Thanks
>>>> Jean
>>>>
>>>> Sent from my iPod
>>>>
>>>>> On Feb 7, 2015, at 7:27 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>>>>
>>>>> Hi all:
>>>>>
>>>>> This doesn’t seem to have gone through the mail system yesterday, so I’m posting again. Apologies if we eventually have a storm of similar messages.
>>>>>
>>>>> Hi all:
>>>>>
>>>>> Finally finished the examples project. Please review and comment.
>>>>>
>>>>> You can get it from svn at https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>>>>>
>>>>> My thinking is that a new user trying out the examples will start with the read me file at: “README.md” (formatted as markdown
>>>>> so that in case someone is looking at the github mirror, they’ll see it on the front page of the project). So, if one or more of you could checkout the project and begin by following the README.md instructions, that would give us a feel for the “new-user” experience.
>>>>>
>>>>> I’m picturing that we should be able to release the examples project fairly quickly, and then start trying to publicize it. Also, we can add more advanced examples as time goes on (e.g. event notifications, transactions, JavaSpaces, web app client, etc).
>>>>>
>>>>> Thanks,
>>>>>
>>>>> Greg Trasuk.
>>>
Re: River-examples project
Posted by Patricia Shanahan <pa...@acm.org>.
I think either remove it completely, or if it has value in other
contexts move it to a separate folder with a description explaining its use.
On 7/1/2015 9:17 PM, Jean Cote wrote:
> I think it should be removed to prevent confusion.
>
> Sent from my iPod
>
>> On Jul 1, 2015, at 2:49 PM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>
>>
>> It’s a hold-over from the old examples folder that I started with. It starts up an http server that serves out the contents of the ‘lib-dl’ folder. In the older examples in the JTSK, the pattern was to start up the class server separately. In the new examples that I did, both the 'start-infra.config’ and ’start-hello-service.config’ files include entries to start their own class servers, so they are independent (if you look carefully, you’ll see that they specify different ports for the http server).
>>
>> So you’re right, the ‘start-class-server.config’ file is not used in the examples instructions, although it might be useful as an example of what entries to include in a starter configuration file. I’d be interested in opinions as to whether we should just take it out of the new examples project.
>>
>> Cheers,
>>
>> Greg Trasuk
>>
>>> On Jul 1, 2015, at 2:59 PM, Jean Cote <je...@gmail.com> wrote:
>>>
>>> Greg
>>>
>>> Thanks for doing this. It is very useful.
>>> There is a file called 'start-class-server.config' that doesn't seem to have any use. Any clue why you created it?
>>>
>>> Thanks
>>> Jean
>>>
>>> Sent from my iPod
>>>
>>>> On Feb 7, 2015, at 7:27 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>>>
>>>> Hi all:
>>>>
>>>> This doesn’t seem to have gone through the mail system yesterday, so I’m posting again. Apologies if we eventually have a storm of similar messages.
>>>>
>>>> Hi all:
>>>>
>>>> Finally finished the examples project. Please review and comment.
>>>>
>>>> You can get it from svn at https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>>>>
>>>> My thinking is that a new user trying out the examples will start with the read me file at: “README.md” (formatted as markdown
>>>> so that in case someone is looking at the github mirror, they’ll see it on the front page of the project). So, if one or more of you could checkout the project and begin by following the README.md instructions, that would give us a feel for the “new-user” experience.
>>>>
>>>> I’m picturing that we should be able to release the examples project fairly quickly, and then start trying to publicize it. Also, we can add more advanced examples as time goes on (e.g. event notifications, transactions, JavaSpaces, web app client, etc).
>>>>
>>>> Thanks,
>>>>
>>>> Greg Trasuk.
>>
Re: River-examples project
Posted by Jean Cote <je...@gmail.com>.
I think it should be removed to prevent confusion.
Sent from my iPod
> On Jul 1, 2015, at 2:49 PM, Greg Trasuk <tr...@stratuscom.com> wrote:
>
>
> It’s a hold-over from the old examples folder that I started with. It starts up an http server that serves out the contents of the ‘lib-dl’ folder. In the older examples in the JTSK, the pattern was to start up the class server separately. In the new examples that I did, both the 'start-infra.config’ and ’start-hello-service.config’ files include entries to start their own class servers, so they are independent (if you look carefully, you’ll see that they specify different ports for the http server).
>
> So you’re right, the ‘start-class-server.config’ file is not used in the examples instructions, although it might be useful as an example of what entries to include in a starter configuration file. I’d be interested in opinions as to whether we should just take it out of the new examples project.
>
> Cheers,
>
> Greg Trasuk
>
>> On Jul 1, 2015, at 2:59 PM, Jean Cote <je...@gmail.com> wrote:
>>
>> Greg
>>
>> Thanks for doing this. It is very useful.
>> There is a file called 'start-class-server.config' that doesn't seem to have any use. Any clue why you created it?
>>
>> Thanks
>> Jean
>>
>> Sent from my iPod
>>
>>> On Feb 7, 2015, at 7:27 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>>
>>> Hi all:
>>>
>>> This doesn’t seem to have gone through the mail system yesterday, so I’m posting again. Apologies if we eventually have a storm of similar messages.
>>>
>>> Hi all:
>>>
>>> Finally finished the examples project. Please review and comment.
>>>
>>> You can get it from svn at https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>>>
>>> My thinking is that a new user trying out the examples will start with the read me file at: “README.md” (formatted as markdown
>>> so that in case someone is looking at the github mirror, they’ll see it on the front page of the project). So, if one or more of you could checkout the project and begin by following the README.md instructions, that would give us a feel for the “new-user” experience.
>>>
>>> I’m picturing that we should be able to release the examples project fairly quickly, and then start trying to publicize it. Also, we can add more advanced examples as time goes on (e.g. event notifications, transactions, JavaSpaces, web app client, etc).
>>>
>>> Thanks,
>>>
>>> Greg Trasuk.
>
Re: River-examples project
Posted by Greg Trasuk <tr...@stratuscom.com>.
It’s a hold-over from the old examples folder that I started with. It starts up an http server that serves out the contents of the ‘lib-dl’ folder. In the older examples in the JTSK, the pattern was to start up the class server separately. In the new examples that I did, both the 'start-infra.config’ and ’start-hello-service.config’ files include entries to start their own class servers, so they are independent (if you look carefully, you’ll see that they specify different ports for the http server).
So you’re right, the ‘start-class-server.config’ file is not used in the examples instructions, although it might be useful as an example of what entries to include in a starter configuration file. I’d be interested in opinions as to whether we should just take it out of the new examples project.
Cheers,
Greg Trasuk
> On Jul 1, 2015, at 2:59 PM, Jean Cote <je...@gmail.com> wrote:
>
> Greg
>
> Thanks for doing this. It is very useful.
> There is a file called 'start-class-server.config' that doesn't seem to have any use. Any clue why you created it?
>
> Thanks
> Jean
>
> Sent from my iPod
>
>> On Feb 7, 2015, at 7:27 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>>
>> Hi all:
>>
>> This doesn’t seem to have gone through the mail system yesterday, so I’m posting again. Apologies if we eventually have a storm of similar messages.
>>
>> Hi all:
>>
>> Finally finished the examples project. Please review and comment.
>>
>> You can get it from svn at https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>>
>> My thinking is that a new user trying out the examples will start with the read me file at: “README.md” (formatted as markdown
>> so that in case someone is looking at the github mirror, they’ll see it on the front page of the project). So, if one or more of you could checkout the project and begin by following the README.md instructions, that would give us a feel for the “new-user” experience.
>>
>> I’m picturing that we should be able to release the examples project fairly quickly, and then start trying to publicize it. Also, we can add more advanced examples as time goes on (e.g. event notifications, transactions, JavaSpaces, web app client, etc).
>>
>> Thanks,
>>
>> Greg Trasuk.
Re: River-examples project
Posted by Jean Cote <je...@gmail.com>.
Greg
Thanks for doing this. It is very useful.
There is a file called 'start-class-server.config' that doesn't seem to have any use. Any clue why you created it?
Thanks
Jean
Sent from my iPod
> On Feb 7, 2015, at 7:27 AM, Greg Trasuk <tr...@stratuscom.com> wrote:
>
> Hi all:
>
> This doesn’t seem to have gone through the mail system yesterday, so I’m posting again. Apologies if we eventually have a storm of similar messages.
>
> Hi all:
>
> Finally finished the examples project. Please review and comment.
>
> You can get it from svn at https://svn.apache.org/repos/asf/river/river-examples/river-examples/trunk
>
> My thinking is that a new user trying out the examples will start with the read me file at: “README.md” (formatted as markdown
> so that in case someone is looking at the github mirror, they’ll see it on the front page of the project). So, if one or more of you could checkout the project and begin by following the README.md instructions, that would give us a feel for the “new-user” experience.
>
> I’m picturing that we should be able to release the examples project fairly quickly, and then start trying to publicize it. Also, we can add more advanced examples as time goes on (e.g. event notifications, transactions, JavaSpaces, web app client, etc).
>
> Thanks,
>
> Greg Trasuk.