Tasks #1222

Document binary installation of rsb-java: JAR download and Maven

Added by S. Wrede almost 9 years ago. Updated over 7 years ago.

Status:ResolvedStart date:10/29/2012
Priority:NormalDue date:
Assignee:S. Sharma% Done:

100%

Category:Java
Target version:rsb-0.11

Description

While the CI-Job is building the JAR-artefact, the documentation lacks an explanation where to find and how to install the JAR library. <- done

Additionally, we could also explain how to use the Maven repository-based installation. <- todo

help_maven.txt Magnifier - steps for installation (4.08 KB) S. Sharma, 01/23/2014 03:36 PM

patch.zip (3.82 KB) S. Sharma, 01/30/2014 07:25 PM

0003-Fix-trailing-whitespace.patch Magnifier (3.82 KB) J. Wienke, 01/31/2014 12:45 PM

0004-Syntax-and-style-fixes.patch Magnifier (1.21 KB) J. Wienke, 01/31/2014 12:45 PM

0005-Improved-java-installation-documentation.patch Magnifier (5.27 KB) J. Wienke, 01/31/2014 12:45 PM

0006-Fixed-tabs.patch Magnifier (2.12 KB) J. Wienke, 01/31/2014 12:45 PM

Associated revisions

Revision 4a0908bf
Added by J. Wienke over 7 years ago

fixes #1222: Fixed tabs

Converted all tabs to spaces and fixed the indentations.

History

#1 Updated by J. Moringen almost 9 years ago

The description is in the master branch of the manual.

I didn't know we had a maven repository. Where can I find it?

#2 Updated by J. Wienke almost 9 years ago

We do not have. CITEC has.

#3 Updated by S. Wrede almost 9 years ago

@Johannes: This is no reason why we shouldn't incorporate that information.

#4 Updated by J. Wienke almost 9 years ago

I don't think it's a good idea to document something that is potentially out of date. If we decide to maintain the RSB maven packages on our own, this is a different story.

#5 Updated by S. Wrede almost 9 years ago

Even though, we should add a note which just informs the reader that there exists the Maven repository in that other place. That does not imply that we take over any "responsibility" for this. We may even attach an "unsupported" sticker to it if you think that is required. I just want to let people know about its existence...

#6 Updated by J. Wienke almost 9 years ago

Didn't we once think about giving a general tutorial for installation methods on docs.cor-lab.org and remove every installation procedure apart from source builds from each manual. In that case we could add a general hint about the maven repository in that tutorial.

#7 Updated by J. Moringen almost 9 years ago

  • Status changed from New to Feedback
  • Assignee set to S. Wrede

What is needed to resolve or maybe reject this? Backport the description from master? Document maven-based installation?

#8 Updated by J. Wienke over 8 years ago

  • Target version changed from rsb-0.7 to rsb-0.9

#9 Updated by J. Moringen over 8 years ago

  • Subject changed from Document Binary Installation of RSBJava to Document binary installation of rsb-java

Is this still a valid task? If I remember correctly, we decided to remove all binary installation methods from the Robotics Service Bus manual and only keep from-source methods.

#10 Updated by J. Moringen over 8 years ago

  • Target version changed from rsb-0.9 to rsb-0.10

#11 Updated by J. Moringen almost 8 years ago

  • Subject changed from Document binary installation of rsb-java to Document binary installation of rsb-java: JAR download and Maven
  • Description updated (diff)
  • Status changed from Feedback to In Progress
  • Target version changed from rsb-0.10 to rsb-0.11
  • % Done changed from 0 to 50

#12 Updated by S. Wrede almost 8 years ago

  • Assignee changed from S. Wrede to F. Lier
  • % Done changed from 50 to 60

I suppose that we should already for 0.10 document the Maven-based installation due to the ISY students and other that might want to use Maven. I've just posted basic information about this on the RSB Mailing list.

However, some issues (partially related to RSB itself) popped up:

  1. What is the correct CITEC repo URL? The one I referenced was more or less guessed from an old message by David Klotz.
  2. The CITEC snapshot repo didn't work well in my Netbeans 7 setup. It showed no entries and only an empty root folder.
  3. We need to deploy our updated releases to the CITEC maven repo if we want to support this way of using RSB.
  4. Is there already any CI job that tests the maven way of RSB usage? Related: Can we add a CI job that deploys udpates to the Maven repo?

@Florian: Can you shed some light on these issues?

#13 Updated by S. Wrede almost 8 years ago

@Johannes: Maybe you can also post some information about that?

#14 Updated by J. Wienke almost 8 years ago

Sebastian Wrede wrote:

I suppose that we should already for 0.10 document the Maven-based installation due to the ISY students and other that might want to use Maven. I've just posted basic information about this on the RSB Mailing list.

However, some issues (partially related to RSB itself) popped up:

  1. What is the correct CITEC repo URL? The one I referenced was more or less guessed from an old message by David Klotz.
  2. The CITEC snapshot repo didn't work well in my Netbeans 7 setup. It showed no entries and only an empty root folder.
  3. We need to deploy our updated releases to the CITEC maven repo if we want to support this way of using RSB.

We do for SNAPSHOT releases. However, the policy for the repo was so far that released version should be uploaded manually and not from a CI server.

  1. Is there already any CI job that tests the maven way of RSB usage? Related: Can we add a CI job that deploys updates to the Maven repo?

As mentioned above... https://ci.cor-lab.org/view/rsb-trunk/job/rsb-java-trunk-maven-deploy/ but not for released version due to the policy.

@Florian: Can you shed some light on these issues?

#15 Updated by S. Wrede almost 8 years ago

Johannes Wienke wrote:

Sebastian Wrede wrote:

  1. The CITEC snapshot repo didn't work well in my Netbeans 7 setup. It showed no entries and only an empty root folder.
  2. We need to deploy our updated releases to the CITEC maven repo if we want to support this way of using RSB.

We do for SNAPSHOT releases. However, the policy for the repo was so far that released version should be uploaded manually and not from a CI server.

Does the snapshot repository (https://repo.cit-ec.uni-bielefeld.de/content/repositories/public-snapshots/) work in your setup (from a user perspective)? As stated in 2., this did not work yesterday using Netbeans 7 from a non-university IP.

#16 Updated by J. Wienke almost 8 years ago

I never tried, but this would be a general issue with he repository then and not related to RSB.

#17 Updated by J. Wienke almost 8 years ago

From a webbrowser here at the university I could list things. So in general it seems to be functional.

#18 Updated by J. Moringen almost 8 years ago

  • Target version changed from rsb-0.11 to rsb-0.10

#19 Updated by J. Moringen almost 8 years ago

  • Assignee changed from F. Lier to S. Sharma

#20 Updated by J. Moringen almost 8 years ago

  • Target version changed from rsb-0.10 to rsb-0.11

#21 Updated by S. Sharma almost 8 years ago

Installed RSB with maven, installation on techfak system was quite easy but on my personal laptop it was really a tedious task as few issues with java , cmake and maven had to be solved , there were initial error due to some missing non-rsb libraries and configurations.
Attached is a rough draft of steps to follow to install RSB with source and with jar both.

#22 Updated by J. Wienke over 7 years ago

I can see a few issues with your description:

mkdir -p build && cd build
no need of cd build as there are no cmake file in build folder and this gives error

You probably missed the ".." in the cmake call. We always want to do out of source builds (http://www.cmake.org/Wiki/CMake_FAQ#Out-of-source_build_trees)

need to specify what in "prefix" install dir is build dir or new dir

I don't understand this

changes in pom.xml

You should get around manually editing the pom file by specifying properties with -D on the maven command line that override the default values in the pom file. Could you please verify that this approach works?

For updating the documentation after you checked these issues, please follow these instructions:

  1. checkout the documentation repository https://code.cor-lab.org/git/rsb.git.manual. This repository contains the sources for the manual which are written using the documentation generator Sphinx (http://sphinx-doc.org/index.html)
  2. create a feature branch for this issue by executing
    git checkout -b task-1222
       
  3. Change the respective documents in the manual project. Please follow the coding standards for the documentation.
  4. Verify that your changes work correctly be compiling the manual with the provided cmake scripts (out of source build, again)
  5. Once everything works, commit your changes
  6. Create a patch with
    git format-patch master
       
  7. Attach the patch to this issue so that we can review it.

#23 Updated by S. Sharma over 7 years ago

Patch ´0001-updated-for-maven-installation-steps.patch´ created .
I have few questions regarding editing rst files :
1. How to create links , like link ´Apache Ant`_ that points to apache website, same has to be done for
/ ´Maven`_
2. Is there any folder tag like :file:´´ for files, to denote ´rsb.git.java folder´
3. Is the tag :program:`mvn` correct for command ´mvn´.
4. For ini file we have tag .. code-block:: ini is it ok for pom.xml as well ?

#24 Updated by J. Moringen over 7 years ago

Patch ´0001-updated-for-maven-installation-steps.patch´ created .

Please attach the patch to this issue. You can upload new versions of the patch as you improve it.

I have few questions regarding editing rst files :
1. How to create links , like link ´Apache Ant`_ that points to apache website, same has to be done for ´Maven`_

You can find examples in conf.py.in in the rst-manual project. It is also possible to define new link targets on the fly. Consult Sphinx documentation for details.

2. Is there any folder tag like :file:´´ for files, to denote ´rsb.git.java folder´

I tried to find a Sphinx directive for directories once, but :file: seems to be the only one. I suggest using :file: for both files and directories.

3. Is the tag :program:`mvn` correct for command ´mvn´.

I think so. Again, when in doubt, consult the Sphinx documentation.

4. For ini file we have tag .. code-block:: ini is it ok for pom.xml as well ?

You can probably use .. code-block:: xml. I haven't tried it, though.

#25 Updated by S. Sharma over 7 years ago

  • File patch.zip added
  • % Done changed from 80 to 90

Incorporated above changes ,please review the attached patches.

#26 Updated by J. Moringen over 7 years ago

Looks pretty good to me.

@Johannes: what do you think?

#27 Updated by J. Wienke over 7 years ago

I'd propose the following additional patches.

Besides style fixes the important thing is that I removed the pom modification steps as they are not the intended way to compile the project.

#28 Updated by J. Wienke over 7 years ago

  • Status changed from In Progress to Resolved
  • % Done changed from 90 to 100

Applied in changeset rsb-manual|commit:4a0908bf8f4cc7c1fb903b2ed6acc62f2e791cd0.

Also available in: Atom PDF