wiki:WikiStart/Releases/08.2011

Version 62 (modified by sylvain.joyeux, 8 years ago) (diff)

--

Participants

  • Sylvain Joyeux
  • Janosch Machowinski
  • Alexander Duda
  • Jakob Schwendner
  • Thomas Röhr

Aims and goals

  • cleaning up documentation
    • remove outdated documentation
    • add new stuff if needed (and time)
    • write a paragraph on what's the difference to ROS and how to integrate with ROS
  • writing and testing tutorials
    • library development
    • component development
    • basic ruby scripting
    • using Vizkit for GUI
    • creating new vizkit widgets
    • log management / replay
    • supervision layer

Ideas

  • Use log data in the tutorials !

Tasks

High priority

  • Bugfixes
    • make Vizkit createPlugin load typekits automatically
    • fix 'lag' in vizkit display / connection to vizkit plugin
      • check vizkit speed on another machine than Janosch' laptop
      • also happens with envire, might be a problem of missing GPU support on X200s, needs verification
    • implement property update scheme as discussed a while ago on the ML
      • implement API
      • implement value freeze [Sylvain]
    • figure out how to solve the automatic rebuild of orocos.rb
      • add optional dependency of gui/vizkit on tools/orocos.rb
    • add doc method to task context
    • display task documentation in oroinpect
    • check for type in property default value
    • default view in vizkit [Janosch]
    • color of rigidbodystatevisualization is broken [Janosch]
    • add and show operation documentation in package directory and oroinspect [Sylvain]
  • general website layout
    • add background color to the 3 blocks
    • make the step-by-step installation link stand out
    • replace "Use It" content by tutorial links, make tutorial link stand out
    • make the mailing lists links stand out
    • Home is a link from the "logo"
    • top menu becomes the main level => Installation / Documentation / Browse Packages / News / Community
    • left menu covers only second-level items
    • submenus inserted below their main item
    • About Rock page
    • redesign footer: Contact, About links
    • news page
    • Advanced System Deployment => Running Systems
    • make the link, in the left menu, between Documentation and Additional Core Functionality clearer
  • discuss about the package directory > documentation page on how to find package information / documentation ("how to browse")
    • add vizkit plugins / widgets [Sylvain]
    • use the layout to create a tree structure on the left side
    • description of what is the package directory
    • add summary page with all packages, make it searchable
    • add tag cloud
    • add "type provided by / used by" information to the type pages
    • move package documentation at the top of the package page (before the table)
    • add a "doc" tag for task contexts, and display it in the generated webpages
    • orogenTypes -> make produced by and consumed by an enumeration
    • orogenTypes -> BUG consumed by produced by are switched
  • up-to-dateness check on the current documentation
    • check for uptodateness of templates
  • consistency / readability / understandability check
  • Troubleshooting page / debugging techniques (wiki)
  • document the new orogen "doc" tag in task_context
  • add some documentation to all the task contexts
  • update the inf/nan guideline, add functions to base, make the guideline accepted
  • create a "how to get a package" page, link to it from the joystick tutorial
    • add mention that one should reload env.sh
  • Tutorials

Can be found under :

https://gitorious.org/rock-tutorials/ and http://gitorious.org/rock/doc

  • define audience / prerequisites
  • stress out the naming scheme(s)
  • individual tutorial structure:
    • "Abstract" >> Contains what you will learn and general summary, what the tutorial about
    • "CUSTOM"
    • "Summary"
  • 1. Workflow outline - Basics develop and running components [Thomas]
    • a. create library (producer / consumer): two classes, one generates a string with timestamp and the other one displays it. Two separate packages. Integration in the build system.
    • b. create corresponding orogen tasks. Two separate packages.
    • c. Start script with Ruby. Integration in the build system.
    • d. embed configuration
    • provide source files for the tutorial
  • 2. Logging and replay [Alex]
    • a. enable logging
    • b. replay, log replay
    • c. rock-display
    • explain the mapping between stream names and the Ruby code. Add a short explanation on "pocolog logfile" to inspect what is in a logfile.
  • 3. Visualization and data analysis [Alex/Janosch]
    • a. display log data
    • b. ui files, gui development vizkit widget
    • c. 3D-data vizkit plugins (Janosch)
  • 4. Plotting Data (Jakob)
    • a. gnu plot
  • 5. Rolling Rock - holistic example/showcase [Janosch]
    • a /b. writing "control component" and its deployment (MotionCommand => Pose). Integration in build system. Run it while sending command from ruby script. Visualization (pose and motion command) using vizkit plugin in the ruby script.
    • c. Integration of Joystick into Showcase
    • d. Use a GUI to steer the rock e.g. the Virtual Joystick widget.
  • document the Rock CMake macros
  • documentation / tutorials / examples on specific "issues"
    • using envire
    • system distribution (CORBA vs. avahi)
    • styleguide documentation, where to put and where to reference (can we actually publish the adapted google-styleguide)
  • Tools
    • create rock-inspect (Alex)
      • displaying available widgets vizkit/vizktit.rb
    • rename rock-create-vizkit-widget to rock-create-vizkit3d-plugin
    • create the real rock-create-vizkit-widget
  • "how do we relate to ROS" page
  • write a page about the base types
  • improve autoproj workflow for creating new package sets

MEDIUM PRIORITY TASKS

Will have to be done before the release

  • publish the new rock.base with updated master/next/stable
  • check the body frame convention in code that should be released
  • manifest.xml > what policy on using depend vs. rosdep
    • make a guideline out of it
  • move some more packages from DFKI internal servers to gitorious (list which ones, cleanup, publication)
  • documentation / tutorials / examples on specific "issues"
    • how to write a device driver
    • documentation on taskmon (top-like visualization ?)

LOW PRIORITY TASKS

Nice to have, but not release showstoppers

  • "systems using Rock" page => detailed examples / use cases
    • need clearing it with DFKI management
  • add runtime dependencies to autoproj, e.g. dependencies that are build but do not trigger a rebuild, to fix the orogen project => orocos.rb dependency problem
  • website search: search input should be at the right of the toplevel main menu
  • package directory
    • description of each category (? only if configurable)
    • documentation on package sets / metapackages
  • add tags to the packages manifest.xml
  • debian packaging [LOW PRIORITY]
  • cross compilation [LOW PRIORITY]
  • finalize transformer integration / document the transformer
  • Fedora support for autoproj / rock
  • "roswtf"-like tool
  • documentation / tutorials / examples on specific "issues"
    • documentation on specific tasks
      • stereo image processing
      • creating a pointcloud of an environment (using laser scanner + dynamixel + icp / envire)
      • using the corridor navigation stack
      • ...
  • Tutorials
    • 4. Showcase
      • e. if time rock trajectory following
      • f. rock following an rock

  • 5. Advanced
    • writing a c++ qt widget for vizkit.rb
    • stream aligner (visualization for the stream aligner status)
    • supervision