Details

    • Type: Bug Bug
    • Status: Reopened
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 1.0, 1.0.1, 1.1-BETA1, 1.1-BETA2, 1.1-BETA3, 1.1-BETA4, 2.0.0
    • Fix Version/s: None
    • Component/s: Build, Java
    • Labels:
      None

      Description

      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.

      1. BUILD-JAVA.patch
        3 kB
        Benjamin McCann

        Activity

        Hide
        John Hjelmstad added a comment -

        I'm low on bandwidth, but if you had a suggested patch on the docs I'd be happy to review and commit it.

        Show
        John Hjelmstad added a comment - I'm low on bandwidth, but if you had a suggested patch on the docs I'd be happy to review and commit it.
        Hide
        Benjamin McCann added a comment -

        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?

        Show
        Benjamin McCann added a comment - 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?
        Hide
        John Hjelmstad added a comment -

        I'd prefer BUILD-JAVA – the closer to the code the docs are, the better.

        Show
        John Hjelmstad added a comment - I'd prefer BUILD-JAVA – the closer to the code the docs are, the better.
        Hide
        Benjamin McCann added a comment -

        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

        Show
        Benjamin McCann added a comment - 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
        Hide
        John Hjelmstad added a comment -

        Patch committed, thanks Ben!

        Show
        John Hjelmstad added a comment - Patch committed, thanks Ben!
        Hide
        Benjamin McCann added a comment -

        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

        Show
        Benjamin McCann added a comment - 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

          People

          • Assignee:
            Unassigned
            Reporter:
            Benjamin McCann
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Development