[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
[incubation] Hosting project documentation on readthedocs.io
|
- From: Patrick Masselink <patrick.masselink@xxxxxxxxxxxxxx>
- Date: Fri, 31 Jan 2020 16:01:30 +0000
- Accept-language: en-US
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=adlinktech.com; dmarc=pass action=none header.from=adlinktech.com; dkim=pass header.d=adlinktech.com; arc=none
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=v/29RreVipNtaYD9uL/ftL9IXxsAC3+avfvKwUJFQT8=; b=bl2jf79PcEZRKXfue7gqorL0rn2CS+So82BLiXdB+z4cmjtl4qUjvyQcg3hNY2rGsTzwMJ5HTvs/3PZJ7e4R3Duwygl+FTZxNuZlbNBt6WQTD8sAu155EM5xM+ayJNNceExVrZq1vtrsEoldkMX+NJikxYtcJlxleJ8eXrZyH++gWUL+3EZHAosLU1TuPGambZmB9Ei+EjUfjP9kLPGZmwDGB97LHQ70zqxDsBeBtZmeQ7hTpGHz0cgFDmkfqYwMKn75hj6QTsJwhywn7QRy0GzE2OkQws8PSgOyPoZzcz1qR1iq3seMruAs/tvn1s38Mj5qzAE0UUEn9cYtUka4lg==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=MG5V5uwCiJfJsyCcg1KH8aQrYYGzaGvGyjkHjShDaZPeiENB9jnlEX/vGSs43jyWhNsVs7Xv1P1cNStUHuDLB49CYCtQnyzV2RFANCQgUwcYgFbnG+DYxHRcU8+zAWoodkdxH3DPTQ0pQ5THmXjzgH9EXdIRawV+/aTqctC7Z4iaQXy004wl4VQk9cKemsoTTVl6FjlA4izZdD1zzvVMqr81OBQNZgTyDffGWvSjlbcMzmwtnFSOZbaIAnvwPV+6PH2ECnwBs6SvtsdcIOias8OOoC7HbdIKc5RIIMg34tQTyRbai1u+xRq3W7CP4FyuM+xwaxBGh3hzGzkQOBF/Fg==
- Delivered-to: incubation@xxxxxxxxxxx
- List-archive: <https://www.eclipse.org/mailman/private/incubation>
- List-help: <mailto:incubation-request@eclipse.org?subject=help>
- List-subscribe: <https://www.eclipse.org/mailman/listinfo/incubation>, <mailto:incubation-request@eclipse.org?subject=subscribe>
- List-unsubscribe: <https://www.eclipse.org/mailman/options/incubation>, <mailto:incubation-request@eclipse.org?subject=unsubscribe>
- Thread-index: AQHV2E+zOnIz1JwyH0WcHk9TUg/Drg==
- Thread-topic: Hosting project documentation on readthedocs.io
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
