Tasks #1753

Document how to use RST for java with Maven

Added by J. Wienke almost 7 years ago. Updated almost 7 years ago.

Status:ResolvedStart date:02/07/2014
Priority:NormalDue date:
Assignee:S. Sharma% Done:

100%

Category:documentation
Target version:Robotics Service Bus - rsb-0.11

Description

Document how user of RST can use the package from the citec repository in their client projects.

0001-Updated-for-maven-installation.patch Magnifier (1.7 KB) S. Sharma, 02/13/2014 05:43 PM

0002-minor-formatting.patch Magnifier (859 Bytes) S. Sharma, 02/13/2014 05:43 PM

Associated revisions

Revision 329942e5
Added by J. Wienke almost 7 years ago

fixes #1753: explain maven repo usage

Explain how to use the maven CITEC repository for user projects.

Incorporates changes proposed by Suchit Sharma.

Revision 7c4a71e7
Added by J. Wienke almost 7 years ago

Fix CITEC maven repo URL

refs #1753

History

#1 Updated by S. Sharma almost 7 years ago

I was able to install and use rst by following the steps given in documentation .. there is a further link ´installing RST´ (http://docs.cor-lab.de//rst-manual/trunk/html/install.html#build-instructions) in documentation which gives detailed installation steps.
I verified installation by running mvn install command from directory rst/rst-proto/build/java using pom-stable.xml.
- Is the the right way for verification ?
If it is then I think steps already mentioned should be enough for user to install and use RST
- do you think we need to add something to the documentation ?

#2 Updated by J. Moringen almost 7 years ago

Suchit Sharma wrote:

I was able to install and use rst by following the steps given in documentation .. there is a further link ´installing RST´ (http://docs.cor-lab.de//rst-manual/trunk/html/install.html#build-instructions) in documentation which gives detailed installation steps.
I verified installation by running mvn install command from directory rst/rst-proto/build/java using pom-stable.xml.
- Is the the right way for verification ?

I think the idea was to explain how the Robotics Systems Types artifact in the CITEC maven repository can be used in a maven-based project (i.e. without building Robotics Systems Types yourself).

It is still good that you verified the installation instructions, though.

#3 Updated by J. Moringen almost 7 years ago

As Johannes remarked in #1732, you probably have to describe how to add the CITEC maven repository configuation, i.e. something like

<repositories>
  <repository>
    <id>citec</id>
    <name>CITEC Maven Repository Server</name>
    <url>http://repo.cit-ec.uni-bielefeld.de/</url>
    <layout>default</layout>
    <releases>
      <enabled>true</enabled>
    </releases>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>
</repositories>

and use it in a project.

#4 Updated by S. Sharma almost 7 years ago

Attached are patches for changed documentation for rst.

#5 Updated by J. Moringen almost 7 years ago

Did you already push the changes?

#6 Updated by S. Sharma almost 7 years ago

Yes, I have pushed the changes.I thought I had to push the changes .. Was I supposed to do that?

#7 Updated by J. Moringen almost 7 years ago

Of course, we want to push the changes eventually.

However, the point of storing your patches into text files and uploading those to the Redmine issue is to give us an opportunity to review the changes and maybe suggest improvements before you actually push.

Don't worry. We don't do this for every little change. But in this case the topic is rather complicated, as Maven is concerned, so we wanted discuss and maybe improve your changes before adding them to the documentation.

But as I said, don't worry, it's not a big deal.

#8 Updated by J. Wienke almost 7 years ago

  • Status changed from New to Resolved
  • % Done changed from 80 to 100

Applied in changeset rst-manual|commit:329942e5586aa502d213ea969d1c6e8ef9310d0b.

#9 Updated by J. Wienke almost 7 years ago

I have clean up the changes a bit in the repo and force pushed a new commit. In case you want to use your existing clone of the rst-manual repository for further things you need to do the following now:

git reset --hard HEAD~2
git pull --ff-only

Also available in: Atom PDF