Enhancements to/redesign of Fluid Infusion demo pages

James William Yoon jyoon at ocad.ca
Wed Nov 3 18:12:03 UTC 2010


Hi all,

At present, all our demos consist of a quick and raw implementation, some
basic instructions on its usage, and the corresponding html + css + js
(e.g.,
http://build.fluidproject.org/infusion/demos/reorderer/layoutReorderer/demo.html).
This is nice, but we think we can make some improvements to it.

If the purpose of the components demos is to show typical use of the
component, assert its value, and provide a segue into showing integrators
how to use the components, then I think we should consider the following:
- Show the use of components in a more meaningful context (which Jonathan's
been doing a lot of really good work on)
- Provide a high-level description of the component (which the portal
provides; but I think this can be duplicated and moderately extended for the
demo page itself--in this way, the demo pages can be linked to independently
of the portal while simultaneously providing clarity about what the
component does)
- Provide a list of features and functionality of the component (i.e., value
assertion)
- Provide useful, succinct code snippets + ultra-light documentation to give
integrators a taste for how easily the component can be inserted and
manipulated
- Provide links to further reading on the component: API, tutorials, etc.
- Package the full demo code and make it available for download and
tinkering (we might consider adding a readme or other documentation to
accompany the package).

Also, I suspect that making the complete code available for reading directly
beside the demo may not be as useful as we might've initially reasoned.
It'll be a good deal of code once we finish implementing the new component
designs Jonathan has been coming up with, and the initial demo page may not
be the choice environment for an integrator to look through all that code.
Succinct pieces of relevant code might have better impact.

Making these sorts of changes to the demo pages might take a bit of time, so
we wouldn't need to make them happen alongside the current round of demo
updates. However, more demo updates are scheduled on the roadmap for
Infusion 1.4, so if we do go ahead with changes, maybe it'd fit well within
that time frame.

Thoughts?

Cheers,
James
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://fluidproject.org/pipermail/fluid-work/attachments/20101103/b9d93d52/attachment.html>


More information about the fluid-work mailing list