Tasks #1416

Pre-packaged installation tutorial

Added by J. Wienke about 8 years ago. Updated over 3 years ago.

Status:NewStart date:02/07/2014
Priority:NormalDue date:
Assignee:-% Done:

73%

Category:-
Target version:Robotics Service Bus - rsb-1.0

Description

Method (all with dependency tracking):
  • dpkg
  • homebrew
  • pip
  • maven
  • Windows installer downloads
OS:
  • Linux
  • Windows
  • Mac

Front-page:

Table with "OS, Programming Language" as Rows/Cols and Methods as table contents.

Exceptions for:
  • spread
  • possibly protobuf

Subtasks

Tasks #1754: Create empty sphinx projectResolvedS. Sharma

Tasks #1755: Extract different combinations of tools and installation ...ResolvedS. Sharma

Tasks #1756: Extract existing installation instructions as starting po...New

Tasks #1783: Turn collected descriptions into templatesNew

History

#1 Updated by J. Wienke about 8 years ago

  • Description updated (diff)

#2 Updated by J. Wienke about 8 years ago

  • Description updated (diff)

#3 Updated by J. Wienke about 8 years ago

  • Description updated (diff)

#4 Updated by J. Wienke about 8 years ago

  • Description updated (diff)

#5 Updated by J. Wienke about 8 years ago

This is the debian package installation content from the wiki:

Debian Packages

Debian packages for RSC, RSB and related projects can be obtained from the CoR-Lab repository located at http://packages.cor-lab.de.

The steps described in the following sections have to be executed with superuser privileges. For further information on how to integrate the repository for example in the Ubuntu Software Center please use the documentation at http://www.ubuntu.com.

Adding the Repository

Add the following public key to your apt keyring:

-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1.4.10 (GNU/Linux)

mQENBE6dj58BCADYerktYV3BF2QB7ZM9b/M5LNmsllXr+qTrNwT15emAm1HlDg3h
IlrFkJjfATi2DiWuRwYxlssLrPltqgvDwHKe0BDB9usxqGrZNj9tNeMhOZ8y2jRr
GPJFOX6SRtmiAV492wD3WcCcv7bGUZ2li2opLL1slCcY9U++RiqPDs/QWyvoyCcE
6Dner91OHkek3XXTYvWvfcD0vdGRjMaEqGQPOhcRZi/HJxrAY+MhiJuWRMEJb3vz
ykAkqshAzi7L1BlhZUa6qa29Pis77Iw1m3oCl8e0N1MI76Xzmh/fw791E1BxXGxw
xB8oPF9zwblJwiAEF9Z5s47VDzxzhe07uD3HABEBAAG0QkNvUi1MYWIgKENvUi1M
YWIgQWRtaW5pc3RyYXRpb24pIDxjb3JhZG1AdGVjaGZhay51bmktYmllbGVmZWxk
LmRlPokBPgQTAQIAKAUCTp2PnwIbAwUJCWYBgAYLCQgHAwIGFQgCCQoLBBYCAwEC
HgECF4AACgkQ9jNhxXFwfhlc7gf/Rxt7VXIBbTnlo8mvZuogFRW903PDOwPGAi2z
hVxUkuzs202RItotDT3b47oLiESPeLWBo1bH+uhq6cjy05iCRebtj2Pn7EPczjN2
53ViokxnMzoTKpmSt9DwlvZ9QZSFQhmXZck612Yk42fJi4En7EzITaCQd8zTHhVN
fodPVaf7x4qC71pCorPU+VaQFPIuLIcw01w/3PXZrYQyGuEtKPW0kVjMQZXHzRE/
eB31Lb7r8qBiHiEOTBtc1oYCWY9wkHDOYiFgjtEpXgbxowcgcviwwpFOMzlilvlt
owBIyGtLFmLFcv/caZ9BwM85Br+KSzn7E3e4P93mQXihvaTg7LkBDQROnY+fAQgA
0Pe9jTKjBGZrzFMZaH2XwBF88oHOs7a3GajkYlWh1KT1QW80ScuyHpR7hssgOle3
uF/FtZ1C0DeaRPwbV5ZkKFgBXpRAU0w4N2sTGTyp/7GiNnHLa9J0yLZB1UQTf+AO
zLSEt+qD2ZXV97pyoYAqOAc1h0j1fLfuS9M1kpAzfDIuAyXkTGyWu73Mx29+gtdK
OKsMQ987qDIX9UDXQNomZ7lqWfsarfRjmwNO1xqnaN47sL2F5xrMrso+SOdLF8JE
clCBPSfAeEwxOwz+trqjnxqkQjha8vhztSitB1aoDeLRy5sAORo+W480O21YKjeA
BEnMX5TM9BqWPN0DlWrhcwARAQABiQElBBgBAgAPBQJOnY+fAhsMBQkJZgGAAAoJ
EPYzYcVxcH4Z++4IAMCS86JA0JksyAK+To5gqmrCnHilrjHj3nSJqb3KzmLM8t0d
WIFY6OEyyvGKvjNwZIkKkpTnyCU1fp/vWcdvtdtD72N0xgzeAOrBModt+MsvOxlJ
qeF7hmDLdR7dTHMeLj3KAP5mXhR9EvB6fUJarla1BipwhKoupXFT26EdHmcw3nGV
1pEmRcBTlQNkZerHQu0VTRpj45Op9TOxmyGVsB0Qyblf6ve4zYlEZTSykL6cGAoq
7Sx72LWhgdlljJzOr0B8qRpwTl94tk1ULVB+GRcMtko1EK2YJvp5oReft6yoEVRJ
WLWKX3kbuD/ERBWbY46wbeJBB3KqrnKm6ck2xFI=
=6vmi
-----END PGP PUBLIC KEY BLOCK-----

This public key is also available for download here.

Download or copy the public key to a file (e.g. package_server_key.txt) and execute the following command:

#:~> apt-key add package_server_key.txt

Extending Package Source List

Add the following line to the /etc/apt/sources.list file (adapt the release name (e.g. lucid, natty, ...) to match your distribution):

deb http://packages.cor-lab.de/ubuntu oneiric testing

Installing

After updating the apt database you can install the packages from the repository:

#:~> apt-get update
#:~> apt-get install rsb0.6

#6 Updated by J. Wienke about 7 years ago

  • Assignee set to S. Sharma

#7 Updated by S. Sharma about 7 years ago

  • Target version set to rsb-0.11

Could you plaese add the link of the page on cor-lab site from where the below information was taken:

Method (all with dependency tracking):
dpkg
homebrew
pip
maven
Windows installer downloads
OS:
Linux
Windows
Mac

#8 Updated by J. Moringen about 7 years ago

Could you plaese add the link of the page on cor-lab site from where the below information was taken:

If I remember correctly, we just gathered that list from memory. There may be more combinations of installation methods and operating systems to consider.

The actual descriptions of individual methods are scattered among several documentation projects/docs.cor-lab.org.

For this task, we suggest starting with #1754. It may also be a good idea to finish #1732 and #1753 before starting work on this issue.

#9 Updated by S. Wrede about 7 years ago

We (Suchit, Jan, Sebastian) dicussed the general issue today and came up with the following proposal:

  • We consider a dedicated common-install-docs project as useful.
  • This project will provide templates and CMake macros for generating project-specific install documentation from the templates.
  • These macros will be used by specific manual projects. (The manual projects use CMake, so providing the macros in CMake format doesn't seem to be a problem).
  • Installation sections for specific packages that comply to the general installation policies will thus be very easy to generate.
  • In the common-install-doc project we shall start with generic / invariant installation information, e.g., on binary installation from
    • Debian packags
    • Maven repos
    • PyPI packages
    • Homebrew scripts?
    • Windows archives?
  • Initially, we want to deploy the generated project specific installation documentation together with the project specific packages. So, from a user perspective there is now big change except that the binary installation instructions look everywhere the same.

#10 Updated by J. Wienke about 7 years ago

Sounds like a good plan.

For the technical realization: Did you also consider providing either:
  • Python functions that are used to generate fragments of the configuration options for the sphinx project
  • A dedicated sphinx domain

Python might be easier to use for generating complex stuff / contents than the CMake language.

#11 Updated by S. Sharma about 7 years ago

Johannes Wienke wrote:

Sounds like a good plan.

For the technical realization: Did you also consider providing either:
  • Python functions that are used to generate fragments of the configuration options for the sphinx project
  • A dedicated sphinx domain

Python might be easier to use for generating complex stuff / contents than the CMake language.

I haven't considered any of these yet, since I not very familiar with python or cmake so if you have an opinion I can proceed with the approach suggested by you.

#12 Updated by S. Sharma almost 7 years ago

I am using templates like maven installation,pypi installation,etc which contain general information about an installation. For project specific details I use conf.py or import data from text files to fill in the project specific information in between the templates.The problem with this approach is that for every html file we have the content distributed among many files (some data from template rest from different text files to be imported for project specific details).I doubt if this is a nice approach as later if the user wants to update html document he will have to change content which is distributed among different files.We may have to explore option of changing the content programatically.

#13 Updated by S. Sharma almost 7 years ago

We could not discuss our approach for using templates yesterday as Jan was not there in the meeting.
@Jan/Johannes can we have a brief meeting to discuss our appproach.

#14 Updated by S. Sharma almost 7 years ago

adding jan and johannes to watchers of the issue (earlier watchers list was empty)
Suchit Sharma wrote:

We could not discuss our approach for using templates yesterday as Jan was not there in the meeting.
@Jan/Johannes can we have a brief meeting to discuss our appproach.

#15 Updated by J. Wienke almost 7 years ago

Suchit, could you attend the RSB meeting on Thursday, 2pm to present your current results?

#16 Updated by S. Sharma almost 7 years ago

Yes, sure I will attend the thursday meeting.

#17 Updated by J. Moringen over 6 years ago

  • Assignee deleted (S. Sharma)

#18 Updated by J. Moringen about 6 years ago

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

#19 Updated by J. Moringen about 5 years ago

  • Target version changed from rsb-0.12 to rsb-0.14

#20 Updated by J. Moringen almost 5 years ago

  • Target version changed from rsb-0.14 to rsb-0.15

#21 Updated by J. Moringen over 4 years ago

  • Target version changed from rsb-0.15 to rsb-0.16

#22 Updated by J. Moringen over 3 years ago

  • Target version changed from rsb-0.16 to rsb-1.0

Also available in: Atom PDF