[ros-users] Jade Beta

Thu Jun 4 18:31:42 UTC 2015

We do (or more precisely OSUOSL does) have control over the docs.ros.org
webserver.

Currently the "api" folder itself is a symlink to "jade/api".
So if a package "foo" does not have any documentation in "jade" then
"api/foo" simply doesn't exist.

The proposed dummy html files for every package in every distro which
doesn't have documentation is not sufficient imo.
This way deep linking (e.g. "api/foo/something/myinfo.html") would still
fail.

Instead we could have a script (e.g. PHP) intercepting all URLs under "api"
and redirect the client to the "api" of the latest rosdistro which contains
the requested URL.
E.g. "api/foo/something/myinfo.html" gets redirected to
"indigo/api/foo/something/myinfo.html" since
"indigo/api/foo/something/myinfo.html" does not exist.
This could also be achieved with a mod_rewrite rule (but I am not sure if
mod_rewrite allows to specify the rules in a way which doesn't require
future distros to be added manually).

If anybody would like to contribute such a script / ruleset that would be
great.
I am not sure when we would find the time to work on this.

Cheers,
- Dirk

On Wed, Jun 3, 2015 at 6:55 AM, Mike Purvis via ros-users <
ros-users at lists.ros.org> wrote:

> Relatedly, I'm wondering if the server config for docs.ros.org/api could
> be modified to fall back to the most recent available distro. So, for
> example,
>
> http://docs.ros.org/api/roscpp/html/ is a symlink/copy of
> http://docs.ros.org/jade/api/roscpp/html/
>
> But
>
> http://docs.ros.org/api/hardware_interface/html/ is a 302 redirect to
> http://docs.ros.org/indigo/api/hardware_interface/html/ (until
> ros_control is released for Jade)
>
> It's frustrating trying to balance giving users URLs which will be "always
> current" with the reality that some stuff can't be released immediately
> into the new distro and therefore all the /api URLs break.
>
> If you guys have control over the webserver, this fallback behaviour is
> pretty easy to set up in nginx or Apache. Alternatively, you could simply
> generate in the /api folder dummy pages which announce to the user "This
> package's documentation isn't available in ROS Jade, please select a
> previous distro from the list below." Though, a transparent redirect is
> ideal, as it would work with deep links also.
>
> M.
>
>
>
> On 3 June 2015 at 04:01, Isaac I.Y. Saito via ros-users <
> ros-users at lists.ros.org> wrote:
>
>> A possible question might be what we use as the default distro (on
>> wiki or possibly anywhere else): the latest available distro, or the
>> latest LTS?
>>
>> +1 to "default: LTS".
>> With Long-Term Support system from Indigo that had been very much
>> wanted (at least I strongly feel so; LTS and its end-date is one of
>> the most FAQs users/potential users from industry esp. in Japan ask),
>> I thought some (/ many) package maintainers would lean more toward
>> focusing on LTS distros.
>>
>> Isaac
>>
>> On Tue, Jun 2, 2015 at 5:54 PM, Daniel Stonier via ros-users
>> <ros-users at lists.ros.org> wrote:
>> >
>> >
>> > On 7 May 2015 at 05:55, William Woodall via ros-users
>> > <ros-users at lists.ros.org> wrote:
>> >>
>> >> Hi everyone,
>> >>
>> >> For everyone out there that has been working on the documentation for
>> >> Jade, first of all thanks! Second of all, I just wanted to let
>> everyone know
>> >> I just updated the ROS distro versioned blocks on the wiki to accept
>> the
>> >> `_and_newer` and the `_and_older` suffixes. This should make it easier
>> to
>> >> have sections of your wiki pages that stay up to date version to
>> version,
>> >> and should be generally more flexible. Please have a look at the
>> updated
>> >> documentation:
>> >>
>> >> http://wiki.ros.org/WikiMacros#Version
>> >
>> >
>> > Something that would be very useful for us would be to lock down the
>> default
>> > landing page to a particular version. We've got quite a few packages we
>> only
>> > have the resources to support/upgrade for the long term releases (e.g.
>> > indigo) and it's rather repetitive always having to click back from the
>> > latest release page (where we usually put a message saying it's not
>> > supported in this release) back to the indigo page.
>> >
>> > Daniel.
>> >
>> >
>> >>
>> >> Thanks,
>> >>
>> >> On Fri, May 1, 2015 at 6:03 PM, William Woodall
>> >> <william at osrfoundation.org> wrote:
>> >>>
>> >>> Hi guys,
>> >>>
>> >>> tl;dr: Jade beta is out!
>> >>>
>> >>> ----
>> >>>
>> >>> I'm happy to announce we're now in the Jade Beta! We're a few days
>> behind
>> >>> schedule, but thanks to the hard work of all our contributors we've
>> now got
>> >>> all of desktop-full released into Jade and available on
>> packages.ros.org.
>> >>>
>> >>> Even though we're a bit behind schedule, we would like to try and keep
>> >>> the original release date of May 23rd (also world turtle day [1] :D).
>> That
>> >>> gives us just under 23 days until the release. We'll keep that date
>> unless
>> >>> we run into a show stopper within desktop-full.
>> >>>
>> >>> So between now and then I would encourage everyone who is able to:
>> >>>
>> >>> Install `ros-jade-desktop-full` on Ubuntu and test out packages you
>> >>> regularly use.
>> >>>
>> >>> Testing on other platforms is also appreciated!
>> >>>
>> >>> Try out any documentation that you can, including tutorials, package
>> wiki
>> >>> pages, and generated code docs.
>> >>> Continue releasing packages and fill out the gaps between Jade and
>> Indigo
>> >>> where possible.
>> >>>
>> >>> If you find any issues while testing, please locate the issue tracker
>> >>> (usually on the corresponding wiki page for the package, e.g.
>> >>> wiki.ros.org/rviz) and report the issue there.
>> >>>
>> >>> Auditing documentation is more challenging just because there is so
>> much
>> >>> of it and searching on the wiki does not always make it easy to find
>> pages
>> >>> with distribution specific content. So to help with this, I've done
>> some
>> >>> special searches locally on the wiki's web server and compiled a list
>> of
>> >>> pages which _may_ need to be updated for Jade:
>> >>>
>> >>> https://github.com/ros/rosdistro/issues/8284
>> >>>
>> >>> So if you have time, please look at that list, and do a spot check on
>> any
>> >>> pages that you use or have used in the past. Many of the core
>> documentation
>> >>> pages are absent from that list because I've compiled them separately
>> in a
>> >>> GitHub issue here:
>> >>>
>> >>> https://github.com/ros/rosdistro/issues/6878
>> >>>
>> >>> Finally, if you are trying to release a package for Jade and the
>> >>> dependencies are not there yet, please contact the maintainers or ask
>> for
>> >>> help on ros-release at lists.ros.org.
>> >>>
>> >>> Thanks again to everyone who helped get the Jade beta out (mostly) on
>> >>> time.
>> >>>
>> >>> Cheers,
>> >>>
>> >>> P.S. Only ros-jade-desktop is available on armhf right now, we're
>> waiting
>> >>> on an updated set of gazebo5 debs and then we'll have desktop-full on
>> armhf
>> >>> as well. Also, armhf is Trusty only right now.
>> >>>
>> >>> P.S.S. If you are testing gazebo-ros integration, we are aware of an
>> >>> issue with the launch files and are tracking it here:
>> >>>
>> >>> https://github.com/ros-simulation/gazebo_ros_pkgs/issues/323
>> >>>
>> >>> A work around is to install `libgazebo5-dev` manually. We hope to
>> have a
>> >>> proper fix out soon.
>> >>>
>> >>> [1] http://en.wikipedia.org/wiki/World_Turtle_Day
>> >>>
>> >>> --
>> >>> William Woodall
>> >>> ROS Development Team
>> >>> william at osrfoundation.org
>> >>> http://wjwwood.io/
>> >>
>> >>
>> >>
>> >>
>> >> --
>> >> William Woodall
>> >> ROS Development Team
>> >> william at osrfoundation.org
>> >> http://wjwwood.io/
>> >>
>> >> _______________________________________________
>> >> ros-users mailing list
>> >> ros-users at lists.ros.org
>> >> http://lists.ros.org/mailman/listinfo/ros-users
>> >>
>> >
>> >
>> >
>> > --
>> > Phone : +82-10-5400-3296 (010-5400-3296)
>> > Home: http://snorriheim.dnsdojo.com/
>> > Yujin Inno: http://inno.yujinrobot.com/
>> >
>> >
>> > _______________________________________________
>> > ros-users mailing list
>> > ros-users at lists.ros.org
>> > http://lists.ros.org/mailman/listinfo/ros-users
>> >
>> _______________________________________________
>> ros-users mailing list
>> ros-users at lists.ros.org
>> http://lists.ros.org/mailman/listinfo/ros-users
>>
>
>
> _______________________________________________
> ros-users mailing list
> ros-users at lists.ros.org
> http://lists.ros.org/mailman/listinfo/ros-users
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ros.org/pipermail/ros-users/attachments/20150604/e5a875e4/attachment.html>