Skip to content

Meeting minutes 2017 09 07

Roger Sheen edited this page Oct 12, 2017 · 3 revisions

DITA-OT Docs Call — September 07, 2017

Contents

Attendance

  • Kris
  • Roger
  • Shane

OT project status updates

The DITA-OT contributor call was held immediately prior to the docs call. Meeting minutes are available at https://github.com/dita-ot/dita-ot/wiki/Meeting-minutes-2017-09-07.

  • DITA-OT 2.5.3 was released on August 31. See http://www.dita-ot.org/2.5/release-notes.
  • A 2.5.4 branch has been created with 1 fix thus far. (If no other critical patches land in the meantime, this may go into 3.0 instead.)

New issues since last call

1 new issue was created since the last call and fixed in v2.5.3:

Project planning board review

The docs issue tracker at https://github.com/dita-ot/docs/issues currently lists 16 open issues, 132 closed.

Our GitHub Projects boards show the status of issues currently associated with each release milestone and serve as the primary planning overview for upcoming releases:

Pending issues for next release

We still need to create issues for the tasks we intend to complete for 3.0:

  • Update information on preprocess2
  • Add topic on Markdown plug-ins
  • Add topic on Lightweight DITA

See the minutes from our August call for details.

Discussion

Lightweight DITA status

Kris reports that an OASIS committee note is currently in draft and scheduled for release later this year (hopefully in time for DITA Europe). This document will not be a formal specification, but will outline the current state of thinking with requests for comments from the community.

August 26 IA Brainstorming Results

Shane met with Misti Pinter to get a fresh perspective on revising the top-level documentation structure as planned in #121. (Kris had hoped to join them, but had to cancel at the last minute.)

They spent an afternoon whiteboarding and took a first pass at a new top-level structure geared toward orienting first-time users and guiding them to initial success. They came up with a basic outline (shown below) that surfaces several previously-buried sections that are likely to be of interest to most users, including content on customizing HTML, PDF output & generated text, verifying output ("OK, it ran, now what?"), troubleshooting and reference material.

  • about
    • set expectations, including cmd line
    • dita spec support
  • release notes
  • installing
    • migrating from previous versions
  • adding plugins
    • about; source of plugins
    • installing
    • uninstalling
  • building output
    • properties or params
    • dita or ant
    • recommend using log files
    • ref verifying section
  • customizing HTML
  • customizing PDF
  • customizing other output types
  • customizing generated text
    • i18n
    • best practice: text in one plugin and others require it (for what good requiring does)
  • verifying output
    • viewing output
    • viewing logs, log files
  • troubleshooting
    • subtopics for, e.g., HTML included here and in associated sections for building, customizing
  • reference
  • resources

Shane will continue his earlier work-in-progress in a feature branch, so we can build the output and review for further discussion during our October call.

To facilitate updates, separate map files should be used and the feature branch should be (re–) based on the tip of the develop branch to ensure recent changes are included.

Once Shane has captured this snapshot, we'll discuss further, define next steps and figure out how to best allocate remaining tasks among the team members.


https://github.com/dita-ot/docs/wiki/Meeting-minutes-2017-09-07


Created 2017-09-07 16:50