Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repository not registered for documentation indexing? #246

Open
gavanderhoorn opened this issue Apr 6, 2019 · 6 comments
Open

Repository not registered for documentation indexing? #246

gavanderhoorn opened this issue Apr 6, 2019 · 6 comments

Comments

@gavanderhoorn
Copy link

gavanderhoorn commented Apr 6, 2019

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
Copy link
Member

hawesie commented Apr 6, 2019

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

@gavanderhoorn
Copy link
Author

gavanderhoorn commented Apr 6, 2019

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
Copy link
Member

hawesie commented Apr 6, 2019

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

@hawesie
Copy link
Member

hawesie commented Oct 23, 2019

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

@gavanderhoorn
Copy link
Author

gavanderhoorn commented Oct 23, 2019

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
Copy link
Member

hawesie commented Oct 23, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants