[ros-users] ROS versioning & wiki structure
Devon Ash
noobaca2 at gmail.com
Mon Nov 24 15:39:40 UTC 2014
I agree with having the documentation available inside of a .roswiki file.
I like the suggestion about gamification of tutorial contributions/wiki
maintenance. But I do not like it enough to implement it myself, so I guess
I don't like it that much.
I'd like to add that it's not the quality or decay of
tutorials/documentation on the wiki that makes it bad in my perspective,
it's the navigation of the website. Finding relative information and
"picking your own adventure" to coin MPurvis is the major downside.
There is plenty of useful information available, and after 2.5 years of
working with ROS I'm still finding documentation and tutorials that
would've been helpful 2 years ago when starting to integrate into the
community.
tl;dr improve ability to learn from website, find relevant documentation
easier
On Mon, Nov 24, 2014 at 10:18 AM, Jonathan Bohren <jonathan.bohren at gmail.com
> wrote:
> On Mon Nov 24 2014 at 3:38:46 AM Miquel Massot Campos <
> miquel.massot at gmail.com> wrote:
>
>> In my opinion, maintaining a repo and the documentation in two different
>> sites is a bit confusing. One often makes changes to the repository without
>> remembering how the roswiki entry was done, thus breaking the completeness
>> or correctness of it. As most of us are developing on GitHub, would it make
>> sense to have a document in each of our repositories "
>> *something.roswiki"* so that the documentation generator
>>
> pastes it into the roswiki?
>>
>
> I agree. The wiki is broken, and package documentation should reside in
> the packages wherever the code is hosted.
>
> Unfortunately, as Dirk said, "whatever change you propose must be
> implemented by someone." So, I'm asking directly:
>
> What resources does OSRF have to re-work the ROS wiki pages for packages
> and tutorials in a way that simply aggregates documentation from package
> source repositories?
>
> -j
>
> _______________________________________________
> ros-users mailing list
> ros-users at lists.ros.org
> http://lists.ros.org/mailman/listinfo/ros-users
>
>
--
Devon Ash
<a href="http://ca.linkedin.com/pub/devon-ash/48/478/981"
style="text-decoration:none;"><span style="font: 80% Arial,sans-serif;
color:#0783B6;"><img src="
https://static.licdn.com/scds/common/u/img/webpromo/btn_in_20x15.png"
width="20" height="15" alt="View Devon Ash's LinkedIn profile"
style="vertical-align:middle" border="0">View Devon Ash's profile</span></a>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ros.org/pipermail/ros-users/attachments/20141124/d9b31e31/attachment.html>
More information about the ros-users
mailing list