Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [incubation] Hosting project documentation on readthedocs.io
Hi Patrick.

Using readthedocs.io to deploy your documentation is fine. This would be considered an external resource; there's some more about them in the handbook. No formal permission is required, but there are some branding and level playing field requirements.

I'm pretty sure that you're doing this already, but will take the opportunity to reinforce that the sources for the documentation are project content (i.e., they must be stored in a Git repo that is managed by the Eclipse Foundation on behalf of the project). 

Regarding the copyright headers, there are two options outlined in the handbook (and repeated by the documentation generator).
  • Copyright (c) {year} {owner}[ and others]; or
  • Copyright (c) {date} Contributors to the Eclipse Foundation

HTH,

Wayne


On Fri, Jan 31, 2020 at 11:02 AM Patrick Masselink <patrick.masselink@xxxxxxxxxxxxxx> wrote:

Hi all,

I'm working on readthedocs support for hosting Eclipse CycloneDDS documentation. I've found other Eclipse projects already using readthedocs (i.e. IoT-Testware) but still I'd like to ask if there are any potential concerns.

Note the 3rd party tooling involved (Sphinx, doxygen, texlive etc.) is already required today, to build CycloneDDS documentation. My contribution will mostly involve configuration for automated readthedocs builds. Once the mechanism is in place i will apply for automatic RTD builds on pull-requests, to encourage contributors to add and improve documentation and to verify PRs don't break the docs build.

I intend to use a copyright notice similar to IoT-Testware (i.e. Copyright 2020, Eclipse CycloneDDS Contributors) and will also include the license.

Can I go ahead and once finished just do a pull-request? Or do we need any formal permission or i.e. a review of the artifacts we intend to publish?

Thanks,

Patrick Masselink

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


--

Wayne Beaton

Director of Open Source Projects | Eclipse Foundation, Inc.

Back to the top