Skip to main content

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

Thanks to all for the information, we will take this under advisement and determine how to move forward.

Wayne - The current documentation for Github IO is stored in the Eclipse Kura Github repository on the gh-pages branch.

Thanks,
--Dave

On May 2, 2016, at 22:23, Wayne Beaton <wayne@xxxxxxxxxxx> wrote:

TL;DR: No.

Longer answer:

There is no prohibition against posting documentation anywhere (subject to the terms of the SUA and license, of course).

However, the Freedom of Action provision in the Eclipse Development Process requires that project intellectual property be hosted using a service supported by the Eclipse Foundation. The basic logic is that we need to have some guarantee that the IP will persist past any change in the business model of a service.

Theoretically, if we have a means of backing up the content onto EF-managed services and potential to rehost it, then we could use the service, but setting that up requires some effort from the Webmaster. If you want to explore this option, open a bug.

Is the content on GitHub IO stored in an EF-managed repository?

Wayne

On 02/05/16 08:50 AM, Kai Kreuzer wrote:
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



_______________________________________________
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

--
Wayne Beaton
@waynebeaton
The Eclipse Foundation
<eclipsecon-130x100.jpg>
_______________________________________________
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