# Where do I create a ticket for pid documentation?

[I'm returning to ROS for my latest robot project. I'm appreciating it greatly and want to participate in improving it. Right now I'm in an especially good position to report issues from a "new user" perspective.]

At the moment, I'd like to submit a report of errors in the pid wiki page. http://wiki.ros.org/pid

1. I checked the issue trackers. I see "On a wiki page for a package or stack there should be a link at the bottom pointing to where to file tickets." No such luck. (Maybe I'm missing it?)

2. I looked through the list of common organizations on GitHub for ROS packages. "ROS Controls" seems like the closest fit but I didn't find any hits when I searched it for "pid" so I doubt that's it.

3. Searching for "pid" stuff on ROS Answers gets a lot of hits...for process IDs.

4. I'm reporting fairly simple documentation issues so I doubt anyone would have reported them already and it seems a bit too trivial to blast the mailing list.

5. I see the author for the package but I also see the warnings not to contact maintainers directly. I also know how disruptive it can be to handle individual e-mail requests like this.

So...here I am. Help? I want to address the immediate issues with pid but I'm also interested in guidance on doing this better in the future.

Thank you.

--kyler

edit retag close merge delete

Sort by » oldest newest most voted

Sorry I'm slow to answer. I'm just discovering that the issue tracker in bitbucket is OFF by default- but it's enabled now. So you can submit a new issue there: https://bitbucket.org/AndyZe/pid/issu...

Or just send me an email as gvdhoorn suggested. (andyz at utexas dot edu)

more

tl;dr: I'd send Andy Zelenak a direct mail, as the source repository has no issue tracker, and there is no other way to contact the author.

1 . I checked the issue trackers. I see "On a wiki page for a package or stack there should be a link at the bottom pointing to where to file tickets." No such luck. (Maybe I'm missing it?)

Provided the package author / maintainer has submitted the repository for indexing in the right way, clicking the Source link in the Package Summary section (at the top of the wiki page) will take you to the repository containing the sources. In this case, that link takes you to bitbucket.org/AndyZe/pid.git, which also serves as a web page for that repository (not always the case, as Subversion repositories fi don't have that automatically).

From there the issue tracker (at least for Github and Bitbucket) should be a click away.

This particular package though doesn't define the link for bugtracker in its manifest (just one for website, here - see REP-140 for more info), so that is why the PackageHeader(..) macro can't render one for you.

2 . I looked through the list of common organizations on GitHub for ROS packages. "ROS Controls" seems like the closest fit but I didn't find any hits when I searched it for "pid" so I doubt that's it.

That is a good strategy, but the pid package is a user contributed package. I guess this is hard to gauge, especially for new-comers, but most of the ros-* organisations hold packages that are either directly out of Willow Garage (long time ago), or have been moved to more centralised hosting to benefit from slightly more consistent maintenance and support. Unfortunately this package is hosted on BitBucket, so you couldn't find it by searching GitHub.

4 . I'm reporting fairly simple documentation issues so I doubt anyone would have reported them already and it seems a bit too trivial to blast the mailing list.

If by mailing list you mean ros-users, then that is good thinking: it is definitely not the place to report these kind of things to. If only for the reason that there is no guarantee that the author of a package is actually subscribed to it, and you'd be unnecessarily sending 10k+ users email about something they can't actually do anything about.

5 . I see the author for the package but I also see the warnings not to contact maintainers directly. I also know how disruptive it can be to handle individual e-mail requests like this.

I'm curious where you found that warning, I can't find it on the wiki page. Is that on a more general support page somewhere?

And in this case, I think you don't have any other option: the package does not contain a link to a bug tracker, and the source repository (bitbucket.org/AndyZe/pid.git) does not ...

more

2

Perhaps this is where the OP read the warning about contacting moderators: http://wiki.ros.org/Support#Do_Not

( 2016-07-24 17:32:01 -0500 )edit