Infusion 1.5 Dcoumentation

Bates, Simon sbates at ocadu.ca
Fri Apr 25 15:25:48 EDT 2014


I have created Jira tickets for the tasks discussed below and added them to a new documentation planning wiki page:

http://wiki.fluidproject.org/display/fluid/Infusion+Documentation+Plan

Simon

From: fluid-work-bounces at fluidproject.org [mailto:fluid-work-bounces at fluidproject.org] On Behalf Of Bates, Simon
Sent: Friday, April 25, 2014 12:50 PM
To: Fluid Work
Subject: Infusion 1.5 Dcoumentation

Yesterday afternoon, Michelle, Anastasia, Antranig, and I met to discuss a plan for the documentation for the 1.5 release.

Here's what we are thinking:


*       We will use Markdown formatted documents stored in GitHub for the documentation

o   https://github.com/fluid-project/infusion-docs

*       We will try out Steve Githen's tool to extract documentation comments from source code for APIs

In the meeting, we identified the documentation currently in the wiki that we want to move over to Markdown and the other documentation tasks for 1.5.

The meeting notes are below.

Simon

Documentation good right now and to be moved over:


*       Developer Guide / How Infusion Works

o   http://wiki.fluidproject.org/display/docs/How+Infusion+Works

*       API - some nodes are "good"

o   such as http://wiki.fluidproject.org/display/docs/ChangeApplier+API - modern and complete

o   http://wiki.fluidproject.org/display/docs/fluid.model.transformWithRules - old but somewhat correct

o   http://wiki.fluidproject.org/display/docs/DOM+Binder+API - old, somewhat correct, but misleading since insufficiently declarative

o   http://wiki.fluidproject.org/display/docs/Renderer+API - old, mostly correct, but documents the renderer which we despise

o   http://wiki.fluidproject.org/display/docs/fluid.progressiveChecker - rubbish and unhelpful

*       http://wiki.fluidproject.org/display/docs/Component+APIs - these are mostly correct and good since we have tried not to make component API changes for several releases now

*       Anything under Utilities can be "stevified"

o   http://wiki.fluidproject.org/display/docs/Utilities

Things we really want that need updating:


*       How to Guides may be out of date

Tasks:


*       Antranig to check through JIRA: http://issues.fluidproject.org/issues/?jql=project%20%3D%20FLUID%20AND%20fixVersion%20%3D%20%221.5%22%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Tech.%20Documentation%22%20ORDER%20BY%20priority%20DESC

Simon to make JIRAs (Blocker 1.5 Component Technical Documentation):


*       Convert the non-API docs that we want to keep to markdown and commit to new doc space

o   https://daringfireball.net/projects/markdown/syntax

o   https://github.com/fluid-project/infusion-docs

*       Look over the How To Guides and identify what we want to keep and update

*       Find Steve's doc tool

*       Move individual API docs to comments in the source and use Steve's tool to generate docs

*       Investigate GitHub Pages as a deployment solution

*       Grunt task to concatenate individual Markdown files into a single file

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20140425/b24d0b84/attachment.html>


More information about the fluid-work mailing list