Hi Arthur, We’d love to take you up on interest in contributing documentation! I’ll ask David Kinder – a part time Tech Docs volunteer from the Intel team – to add you to our weekly Tech Docs meeting.
(I’ve copied David on this email since I don’t think he’s on the IoTivity dev list at present), Margaret From: [email protected] [mailto:[email protected]] On Behalf Of Arthur Barros Lapprand Sent: Tuesday, January 9, 2018 9:45 AM To: Gregg Reynolds <[email protected]> Cc: iotivity-dev <[email protected]> Subject: Re: [dev] new documentation project Hi Gregg, I may have people interested in contributing to the documentation. Could you please confirm if this is an official project of IoTivity or an Unofficial Initiative? Best regards, A. Lapprand On Mon, Jan 8, 2018, 19:24 Gregg Reynolds <[email protected]<mailto:[email protected]>> wrote: P.S. if XML makes you puke, the DITA Open Toolkit also supports markdown of some kind. I've never used it, but there it is. You have no excuse. On Jan 8, 2018 2:52 PM, "Gregg Reynolds" <[email protected]<mailto:[email protected]>> wrote: I've started a documentation project in case anybody wants to help out. It uses DITA. Just a skeleton so far but there is some info on security there. Nice things about DITA: * You write doc in small chunks that can be easily reused and reorganized. That means you can contribute easily without having to worry about document structure. * It has sophisticated vocabularies for documentation. * It's reasonably easy to get going by copying from existing articles. (The markup is very similar to HTML) * Two open source implementations. * Automated indexing, cross-referencing, etc. * Multiple output formats. * Customizing styles is (relatively) easy (if you know XSL) * It's much easier to manage DITA doc than a Wiki. This is just getting started so it's pretty skeletal, but what is there demonstrates indexing, glossary, and organization of content nodes using a main ditamap file. I've begun filling in the Security part; it's still thin but you can see the narrative stragegy (I hope). Again, reorganizing the main doc is trivial, so if you have other ideas about how to organize the material it is easy to experiment. See https://github.com/OpenOCF/ocfguide. PDF output is in the ./out directory. You can generate HTML output easily, but the stylesheets are pretty primitive so I have not done so. If you lament the state of Iotivity documentation now's your chance to help improve it. If this ever turns into something useful it could be transferred to the Iotivity website, and a customized stylesheet written to generate HTML. HTH, Gregg _______________________________________________ iotivity-dev mailing list [email protected]<mailto:[email protected]> https://lists.iotivity.org/mailman/listinfo/iotivity-dev
_______________________________________________ iotivity-dev mailing list [email protected] https://lists.iotivity.org/mailman/listinfo/iotivity-dev
