You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@shindig.apache.org by "Benjamin McCann (JIRA)" <ji...@apache.org> on 2009/10/26 20:12:59 UTC
[jira] Created: (SHINDIG-1210) Java BUILD documentation needs to be
updated
Java BUILD documentation needs to be updated
--------------------------------------------
Key: SHINDIG-1210
URL: https://issues.apache.org/jira/browse/SHINDIG-1210
Project: Shindig
Issue Type: Bug
Components: Build, Java
Affects Versions: 1.1-BETA3, 1.1-BETA2, 1.1-BETA1, 1.0, 1.1-BETA4, 1.1-RC1, 1.0.1
Reporter: Benjamin McCann
I had significant difficulty building and running the Java server because there are two copies of the documentation, which are both incomplete and have some differences. I didn't get things working until I found both docs and pieced them together. One doc is online (http://incubator.apache.org/shindig/developers/java/build.html) and the other is the BUILD-JAVA doc in the project root.
Can we merge the two? It seems as long as we have two copies of the instructions, that they will always be wrong because someone will update one and not the other. It'd be much preferable to have just one and either the BUILD-JAVA file can contain just the URL web page or the link on the web can point to the SVN web client version.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
Re: [jira] Reopened: (SHINDIG-1210) Java BUILD documentation needs to
be updated
Posted by John Hjelmstad <fa...@google.com>.
Seems reasonable. Anyone have the appropriate Maven mojo to do that
automatically? Or the doc site perms?
On Tue, Oct 27, 2009 at 12:50 PM, Benjamin McCann (JIRA) <ji...@apache.org>wrote:
>
> [
> https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]
>
> Benjamin McCann reopened SHINDIG-1210:
> --------------------------------------
>
>
> Thanks for the fast commit of the changes.
> I want to make sure we're going to update the website too. The really
> frustrating part for me was spending a couple hours trying to use those
> directions when it turned out there were such better directions available in
> the source.
> Let's replace
> http://incubator.apache.org/shindig/developers/java/build.html with
> http://svn.apache.org/repos/asf/incubator/shindig/trunk/BUILD-JAVA
>
> > Java BUILD documentation needs to be updated
> > --------------------------------------------
> >
> > Key: SHINDIG-1210
> > URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> > Project: Shindig
> > Issue Type: Bug
> > Components: Build, Java
> > Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4,
> 1.1-RC1, 1.0.1
> > Reporter: Benjamin McCann
> > Attachments: BUILD-JAVA.patch
> >
> >
> > I had significant difficulty building and running the Java server because
> there are two copies of the documentation, which are both incomplete and
> have some differences. I didn't get things working until I found both docs
> and pieced them together. One doc is online (
> http://incubator.apache.org/shindig/developers/java/build.html) and the
> other is the BUILD-JAVA doc in the project root.
> > Can we merge the two? It seems as long as we have two copies of the
> instructions, that they will always be wrong because someone will update one
> and not the other. It'd be much preferable to have just one and either the
> BUILD-JAVA file can contain just the URL web page or the link on the web can
> point to the SVN web client version.
>
> --
> This message is automatically generated by JIRA.
> -
> You can reply to this email to add a comment to the issue online.
>
>
Re: [jira] Reopened: (SHINDIG-1210) Java BUILD documentation needs to
be updated
Posted by John Hjelmstad <fa...@google.com>.
Seems reasonable. Anyone have the appropriate Maven mojo to do that
automatically? Or the doc site perms?
On Tue, Oct 27, 2009 at 12:50 PM, Benjamin McCann (JIRA) <ji...@apache.org>wrote:
>
> [
> https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]
>
> Benjamin McCann reopened SHINDIG-1210:
> --------------------------------------
>
>
> Thanks for the fast commit of the changes.
> I want to make sure we're going to update the website too. The really
> frustrating part for me was spending a couple hours trying to use those
> directions when it turned out there were such better directions available in
> the source.
> Let's replace
> http://incubator.apache.org/shindig/developers/java/build.html with
> http://svn.apache.org/repos/asf/incubator/shindig/trunk/BUILD-JAVA
>
> > Java BUILD documentation needs to be updated
> > --------------------------------------------
> >
> > Key: SHINDIG-1210
> > URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> > Project: Shindig
> > Issue Type: Bug
> > Components: Build, Java
> > Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4,
> 1.1-RC1, 1.0.1
> > Reporter: Benjamin McCann
> > Attachments: BUILD-JAVA.patch
> >
> >
> > I had significant difficulty building and running the Java server because
> there are two copies of the documentation, which are both incomplete and
> have some differences. I didn't get things working until I found both docs
> and pieced them together. One doc is online (
> http://incubator.apache.org/shindig/developers/java/build.html) and the
> other is the BUILD-JAVA doc in the project root.
> > Can we merge the two? It seems as long as we have two copies of the
> instructions, that they will always be wrong because someone will update one
> and not the other. It'd be much preferable to have just one and either the
> BUILD-JAVA file can contain just the URL web page or the link on the web can
> point to the SVN web client version.
>
> --
> This message is automatically generated by JIRA.
> -
> You can reply to this email to add a comment to the issue online.
>
>
[jira] Commented: (SHINDIG-1210) Java BUILD documentation needs to
be updated
Posted by "John Hjelmstad (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12770344#action_12770344 ]
John Hjelmstad commented on SHINDIG-1210:
-----------------------------------------
I'd prefer BUILD-JAVA -- the closer to the code the docs are, the better.
> Java BUILD documentation needs to be updated
> --------------------------------------------
>
> Key: SHINDIG-1210
> URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> Project: Shindig
> Issue Type: Bug
> Components: Build, Java
> Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4, 1.1-RC1, 1.0.1
> Reporter: Benjamin McCann
>
> I had significant difficulty building and running the Java server because there are two copies of the documentation, which are both incomplete and have some differences. I didn't get things working until I found both docs and pieced them together. One doc is online (http://incubator.apache.org/shindig/developers/java/build.html) and the other is the BUILD-JAVA doc in the project root.
> Can we merge the two? It seems as long as we have two copies of the instructions, that they will always be wrong because someone will update one and not the other. It'd be much preferable to have just one and either the BUILD-JAVA file can contain just the URL web page or the link on the web can point to the SVN web client version.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-1210) Java BUILD documentation needs to
be updated
Posted by "John Hjelmstad (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12770158#action_12770158 ]
John Hjelmstad commented on SHINDIG-1210:
-----------------------------------------
I'm low on bandwidth, but if you had a suggested patch on the docs I'd be happy to review and commit it.
> Java BUILD documentation needs to be updated
> --------------------------------------------
>
> Key: SHINDIG-1210
> URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> Project: Shindig
> Issue Type: Bug
> Components: Build, Java
> Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4, 1.1-RC1, 1.0.1
> Reporter: Benjamin McCann
>
> I had significant difficulty building and running the Java server because there are two copies of the documentation, which are both incomplete and have some differences. I didn't get things working until I found both docs and pieced them together. One doc is online (http://incubator.apache.org/shindig/developers/java/build.html) and the other is the BUILD-JAVA doc in the project root.
> Can we merge the two? It seems as long as we have two copies of the instructions, that they will always be wrong because someone will update one and not the other. It'd be much preferable to have just one and either the BUILD-JAVA file can contain just the URL web page or the link on the web can point to the SVN web client version.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Reopened: (SHINDIG-1210) Java BUILD documentation needs to
be updated
Posted by "Benjamin McCann (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Benjamin McCann reopened SHINDIG-1210:
--------------------------------------
Thanks for the fast commit of the changes.
I want to make sure we're going to update the website too. The really frustrating part for me was spending a couple hours trying to use those directions when it turned out there were such better directions available in the source.
Let's replace http://incubator.apache.org/shindig/developers/java/build.html with http://svn.apache.org/repos/asf/incubator/shindig/trunk/BUILD-JAVA
> Java BUILD documentation needs to be updated
> --------------------------------------------
>
> Key: SHINDIG-1210
> URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> Project: Shindig
> Issue Type: Bug
> Components: Build, Java
> Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4, 1.1-RC1, 1.0.1
> Reporter: Benjamin McCann
> Attachments: BUILD-JAVA.patch
>
>
> I had significant difficulty building and running the Java server because there are two copies of the documentation, which are both incomplete and have some differences. I didn't get things working until I found both docs and pieced them together. One doc is online (http://incubator.apache.org/shindig/developers/java/build.html) and the other is the BUILD-JAVA doc in the project root.
> Can we merge the two? It seems as long as we have two copies of the instructions, that they will always be wrong because someone will update one and not the other. It'd be much preferable to have just one and either the BUILD-JAVA file can contain just the URL web page or the link on the web can point to the SVN web client version.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (SHINDIG-1210) Java BUILD documentation needs to
be updated
Posted by "John Hjelmstad (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
John Hjelmstad resolved SHINDIG-1210.
-------------------------------------
Resolution: Fixed
Patch committed, thanks Ben!
> Java BUILD documentation needs to be updated
> --------------------------------------------
>
> Key: SHINDIG-1210
> URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> Project: Shindig
> Issue Type: Bug
> Components: Build, Java
> Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4, 1.1-RC1, 1.0.1
> Reporter: Benjamin McCann
> Attachments: BUILD-JAVA.patch
>
>
> I had significant difficulty building and running the Java server because there are two copies of the documentation, which are both incomplete and have some differences. I didn't get things working until I found both docs and pieced them together. One doc is online (http://incubator.apache.org/shindig/developers/java/build.html) and the other is the BUILD-JAVA doc in the project root.
> Can we merge the two? It seems as long as we have two copies of the instructions, that they will always be wrong because someone will update one and not the other. It'd be much preferable to have just one and either the BUILD-JAVA file can contain just the URL web page or the link on the web can point to the SVN web client version.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (SHINDIG-1210) Java BUILD documentation needs to be
updated
Posted by "Benjamin McCann (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Benjamin McCann updated SHINDIG-1210:
-------------------------------------
Attachment: BUILD-JAVA.patch
I think BUILD-JAVA was actually the better of the two docs, but I did go ahead and add some info that was only on the web page. Hopefully we can now point the web links instead to http://svn.apache.org/repos/asf/incubator/shindig/trunk/BUILD-JAVA
> Java BUILD documentation needs to be updated
> --------------------------------------------
>
> Key: SHINDIG-1210
> URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> Project: Shindig
> Issue Type: Bug
> Components: Build, Java
> Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4, 1.1-RC1, 1.0.1
> Reporter: Benjamin McCann
> Attachments: BUILD-JAVA.patch
>
>
> I had significant difficulty building and running the Java server because there are two copies of the documentation, which are both incomplete and have some differences. I didn't get things working until I found both docs and pieced them together. One doc is online (http://incubator.apache.org/shindig/developers/java/build.html) and the other is the BUILD-JAVA doc in the project root.
> Can we merge the two? It seems as long as we have two copies of the instructions, that they will always be wrong because someone will update one and not the other. It'd be much preferable to have just one and either the BUILD-JAVA file can contain just the URL web page or the link on the web can point to the SVN web client version.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-1210) Java BUILD documentation needs to
be updated
Posted by "Benjamin McCann (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12770163#action_12770163 ]
Benjamin McCann commented on SHINDIG-1210:
------------------------------------------
I could probably try to merge the docs. Do you have a preference for where the authoritative source should live and which one should go away?
> Java BUILD documentation needs to be updated
> --------------------------------------------
>
> Key: SHINDIG-1210
> URL: https://issues.apache.org/jira/browse/SHINDIG-1210
> Project: Shindig
> Issue Type: Bug
> Components: Build, Java
> Affects Versions: 1.0, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4, 1.1-RC1, 1.0.1
> Reporter: Benjamin McCann
>
> I had significant difficulty building and running the Java server because there are two copies of the documentation, which are both incomplete and have some differences. I didn't get things working until I found both docs and pieced them together. One doc is online (http://incubator.apache.org/shindig/developers/java/build.html) and the other is the BUILD-JAVA doc in the project root.
> Can we merge the two? It seems as long as we have two copies of the instructions, that they will always be wrong because someone will update one and not the other. It'd be much preferable to have just one and either the BUILD-JAVA file can contain just the URL web page or the link on the web can point to the SVN web client version.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.