Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [iot-pmc] Eclipse Kura Documentation

Hi David,

I am currently having the same question for the openHAB documentation. Some people did a German tutorial using readthedocs.org, but I never liked the dependency on a 3rd party and I am pretty reluctant doing that for an Eclipse project.

For Eclipse SmartHome, we are using Markdown for the documentation and have scripts to prepare and aggregate all sources for the docs - A Jekyll job then generates the HTML page (still to be set up as an automatic build job); this gives more flexibility than using Github pages directly, and afaik, Jekyll is pretty powerful and I am currently only scratching its surface.

Regards,
Kai


On 30 Apr 2016, at 10:39, Woodard, David <David.Woodard@xxxxxxxxxxxx> wrote:

Hello,

The Eclipse Kura team is looking at better ways to handle documentation. We are currently using Github IO, but would like to move to something that provides more management features for committers and a better experience for users. We are considering Read the Docs [1], but would like to ask the following questions:

1. Is the Eclipse Foundation okay with us hosting documentation on this site?
2. Do other projects have documentation solutions that they have found useful?


Thanks,
David Woodard
Eclipse Kura Project Lead


_______________________________________________
iot-pmc mailing list
iot-pmc@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/iot-pmc


Back to the top