search

ros-infrastructure / roswiki

Plugins and configurations for wiki.ros.org
wiki.ros.org
24 stars 19 forks source link

Wiki macro to read and display a repository's README file on the main page? #47

Open jbohren opened 11 years ago

jbohren commented 11 years ago

It seems like it's common practice these days to put a lot of information in README files in the top level of ROS packages. Is there any interest to have this information displayed in the wiki?

dirk-thomas commented 11 years ago

The package page already shows the description from the package.xml file. Additionally it has a link to the source repo.

Including the content of additional files (e.g. README) is imo not a good idea. Besides it would require that these information are extracted in the doc job in order to make the information available in the wiki. Therefore I would vote for not implementing this feature. @wjwwood @tfoote Any feedback on this?

wjwwood commented 11 years ago

I don't see a problem with making a macro to allow users to bring in a README file if they wish to, but I'm not sure any of us have time to implement it.

I would not make it part of the default doc job stuff, but they could use explicitly "include" it by url. This is probably more generically a LoadXFrom(Y) kind of macro, e.g. <<LoadMarkdownFrom(https://.../raw/path/to/README.md)>>. Another reason to not make it part of the doc job is that there is no standard for how the README's are called or formatted.

Again, not sure if this is something where we will have time to implement it.