search

strands-project / mongodb_store

MongoDB tools for storing and analysing runs of ROS systems.
BSD 3-Clause "New" or "Revised" License
49 stars 73 forks source link

Repository not registered for documentation indexing? #246

Open gavanderhoorn opened 5 years ago

gavanderhoorn commented 5 years ago

Just noticed that the wiki page doesn't show a Documentation badge.

rosdistro/kinetic/distribution.yaml also shows no doc entry for the package(s).

Is this intentional?

Comparing this to other ROS wiki pages it makes it harder to find the source repository (I'm lazy, so I clicked on "Use GitHub to report bugs or submit feature requests" and then ended up at the issue tracker).

hawesie commented 5 years ago

We do actually have some documentation, so I'll add it to the next release.

gavanderhoorn commented 5 years ago

Doc indexing doesn't depend on having documentation available. Even (almost) empty repositories can be indexed by the ROS buildfarm.

The benefit of having the doc jobs generated is that the Package Summary heading on the wiki page auto-generates some additional information about the repository.

The only thing that would be needed would be a doc entry added for the repository. See this entry for an example. A simple PR adding this would be sufficient.

Edit: link to tutorial.

hawesie commented 5 years ago

Useful to know, thanks. I'll add this to my todo list.

hawesie commented 5 years ago

kinetic and melodic releases are already indexed for documentaiton, but indigo wasn't and that's the base entry on the wiki. Fix added: https://github.com/ros/rosdistro/pull/22736

gavanderhoorn commented 5 years ago

I doubt you'll get that merged, seeing as Indigo has been EOL for some time now.

indigo wasn't and that's the base entry on the wiki

This is strange. For me the wiki shows the latest ROS version a package is being indexed for.

Does it not do that for you?

hawesie commented 5 years ago

Hmmm.... it does now... odd.