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

wiki: move tutorials to github repository #148

Open
gavanderhoorn opened this issue Feb 3, 2015 · 5 comments
Open

wiki: move tutorials to github repository #148

gavanderhoorn opened this issue Feb 3, 2015 · 5 comments

Comments

@gavanderhoorn
Copy link
Member

Similar to how catkin & MoveIt are documented.

It would probably make sense to wait for / contribute some way for in-vcs tutorials to be nicely integrated into the ROS wiki before doing this.

@130s
Copy link
Member

130s commented Mar 21, 2015

+1.

We're on the same boat to seek how to do this. This ticket might be of your interest (but there may not be really a new info).

@gavanderhoorn
Copy link
Member Author

Thanks for the comment. I've discussed this a bit with @shaun-edwards. Personally, I think a short term solution could be to create a new ROS wiki macro that can pull in externally generated MoinMoin. for MoinMoin generation from markdown (fi), something like pandoc could be used (although it currently doesn't seem to support MoinMoin directly. this does though).

More long-term would be to go to an entirely different wiki engine. gitit seems like a nice example of an engine with support for more markup formats than just its own dialect.

@wjwwood wrote an interesting ROS2.0 whitepaper about this very subject recently btw. See ROS 2 Documentation System.

@gavanderhoorn
Copy link
Member Author

Did some testing with Sphinx here. Work in progress, but I like it so far.

Doesn't integrate with the ROS wiki, but I feel the advantages outweigh that disadvantage.

@130s
Copy link
Member

130s commented Jun 6, 2016

Isn't this worth discussing on broader community, like http://discourse.ros.org/?

@gavanderhoorn
Copy link
Member Author

We can do that, but I first wanted to test out some things for myself, hence the test repository.

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

No branches or pull requests

2 participants