search

RobotML / RobotML-and-Portal

all issues and specific documents that concerns link between RobotML tooling and portal
0 stars 0 forks source link

target for robotml documentation needed #36

Closed patinusb closed 10 years ago

patinusb commented 10 years ago

Nowadays we did not define how to proceed when publishing documentation. Here in this issue I am proposing something.

github.com/RobotML/RobotML-documentation provides sphinx based repository. When considering an update, there is a website dedicated to verification of correctness of generated doc. It is robotml.github.io that is used for this process. Published documentation (when correctness has been verified) nevertheless should be located on the portal and thus there is the need of an uploading area dedicated to this part of the documentation.

This issue is dedicated to the creation of this area and how to introduce this documentation correctly in the portal. This is one of the very important issue...

patinusb commented 10 years ago

A question remains on how to render this upload easy. In fact documentation is a set of files and folders in mixed format (html, pdf, png...). Using ftp could be very tidy... Is there an easy way to synchronise folders (through an rsync perhaps?).

patinusb commented 10 years ago

This is linked to issue #2

nmorette commented 10 years ago

A Rsync and a ftp protocol have been opened in order to update the documentation.