BEGIN:VCALENDAR VERSION:2.0 PRODID:-//Pentabarf//Schedule 0.3//EN CALSCALE:GREGORIAN METHOD:PUBLISH X-WR-CALDESC;VALUE=TEXT:Tool the Docs devroom X-WR-CALNAME;VALUE=TEXT:Tool the Docs devroom X-WR-TIMEZONE;VALUE=TEXT:Europe/Brussels BEGIN:VEVENT METHOD:PUBLISH UID:7183@FOSDEM18@fosdem.org TZID:Europe-Brussels DTSTART:20180204T090000 DTEND:20180204T092000 SUMMARY:Automating style guide documentation DESCRIPTION:
This talk is about how, we at Zalando Retail Core, are tackling the problem of providing our developers a great experience when they are using our styleguide. The talk will show that in using Markdown as the documentation format, a couple of convention, documentation.js for generating Markdown from jsdocs comments and our own Styleguide web application, we were able speed up our styleguide and source code documentation and the developer experience. Additionally, without relying on any static generator project with their own convention we are now able to fully control and change the user experience of our styleguide and are owning the whole documentation tool chain.
CLASS:PUBLIC STATUS:CONFIRMED CATEGORIES:Tool the Docs URL:https:/fosdem.org/2018/schedule/2018/schedule/event/documentjs_to_document_a_styleguide_and_source_code/ LOCATION:UD2.119 ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL;CN="Ferit Topcu":invalid:nomail END:VEVENT BEGIN:VEVENT METHOD:PUBLISH UID:6303@FOSDEM18@fosdem.org TZID:Europe-Brussels DTSTART:20180204T092500 DTEND:20180204T095500 SUMMARY:DocBook Documentation at SUSE DESCRIPTION:In the SUSE documentation team, we have been using DocBook XML for years. But then, even with all our experience and the strictness of XML, we still make mistakes. So we have been adding QA tools to our tool belt which we are presenting in this talk:
Using these tools helps us ensure good formal quality, so that human reviewers can focus on the content. It also helps with make translation efficient.
CLASS:PUBLIC STATUS:CONFIRMED CATEGORIES:Tool the Docs URL:https:/fosdem.org/2018/schedule/2018/schedule/event/docbook_documentation_at_suse/ LOCATION:UD2.119 ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL;CN="Stefan Knorr":invalid:nomail END:VEVENT BEGIN:VEVENT METHOD:PUBLISH UID:7212@FOSDEM18@fosdem.org TZID:Europe-Brussels DTSTART:20180204T100000 DTEND:20180204T102000 SUMMARY:Test your API docs! DESCRIPTION:Today many API docs are driven by API description formats, such as Swagger/OpenAPI, API Blueprint, and so on. I'm working on an Open Source tool (Dredd), which takes verifies whether the implementation is according to the description. This enables a whole new workflow to API designers - they can design before implementing, and then ensure the implementation is in sync with the design.
CLASS:PUBLIC STATUS:CONFIRMED CATEGORIES:Tool the Docs URL:https:/fosdem.org/2018/schedule/2018/schedule/event/test_api_docs_with_dredd/ LOCATION:UD2.119 ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL;CN="Honza Javorek":invalid:nomail END:VEVENT BEGIN:VEVENT METHOD:PUBLISH UID:7218@FOSDEM18@fosdem.org TZID:Europe-Brussels DTSTART:20180204T102500 DTEND:20180204T105500 SUMMARY:Docs like code in Drupal DESCRIPTION:When documenting software it makes sense to treat your docs like code. Doing so allows documentarians to collaborate much easier with developers. While most teams have chosen for static site generators to implement this methodology, we identified a number of use cases where it would make much more sense to use a CMS based system. In this talk I explain why, and introduce a new open source project, based on Drupal, that can import Markdown and Open API specifications.
CLASS:PUBLIC STATUS:CONFIRMED CATEGORIES:Tool the Docs URL:https:/fosdem.org/2018/schedule/2018/schedule/event/docs_like_code_in_drupal/ LOCATION:UD2.119 ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL;CN="Kitti Radovics":invalid:nomail END:VEVENT BEGIN:VEVENT METHOD:PUBLISH UID:5963@FOSDEM18@fosdem.org TZID:Europe-Brussels DTSTART:20180204T110000 DTEND:20180204T113000 SUMMARY:A lion, a head, and a dash of YAML DESCRIPTION:The Sphinx documentation tool provides tremendous extensibility and theming options; options which are massively underutilized. We demonstrate how you can go about writing your own extensions and themes for Sphinx and ultimately how you treat your docs like code.
CLASS:PUBLIC STATUS:CONFIRMED CATEGORIES:Tool the Docs URL:https:/fosdem.org/2018/schedule/2018/schedule/event/automating_documentation_with_sphinx_extensions/ LOCATION:UD2.119 ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL;CN="Stephen Finucane":invalid:nomail END:VEVENT BEGIN:VEVENT METHOD:PUBLISH UID:7208@FOSDEM18@fosdem.org TZID:Europe-Brussels DTSTART:20180204T113500 DTEND:20180204T120000 SUMMARY:Mallard, Pintail, and other duck topics DESCRIPTION:Mallard completely reinvented topic-oriented help for GNOME. Learn about Mallard's unique topic organization system. Discover Ducktype, a lightweight but semantic format with all the power of Mallard. And witness Pintail, the all-in-one one documentation site builder built from the ecosystem of Mallard tools.
CLASS:PUBLIC STATUS:CONFIRMED CATEGORIES:Tool the Docs URL:https:/fosdem.org/2018/schedule/2018/schedule/event/mallard_pintail_and_other_duck_topics/ LOCATION:UD2.119 ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL;CN="Shaun McCance":invalid:nomail END:VEVENT BEGIN:VEVENT METHOD:PUBLISH UID:7209@FOSDEM18@fosdem.org TZID:Europe-Brussels DTSTART:20180204T120500 DTEND:20180204T123000 SUMMARY:Finding a home for docs DESCRIPTION:Where docs are stored can impact open source projects in a variety of ways. This talk will present some options, considerations, and guidelines for making an informed decision when choosing a path for docs in current and future projects.
CLASS:PUBLIC STATUS:CONFIRMED CATEGORIES:Tool the Docs URL:https:/fosdem.org/2018/schedule/2018/schedule/event/finding_a_home_for_docs/ LOCATION:UD2.119 ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL;CN="Jessica Parsons":invalid:nomail END:VEVENT END:VCALENDAR