Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Current Showcase App

Situation

There is a need to provide information necessary for using the controls.

Currently there are three tabs in the showcase app:

  1. Form fields - Magnolia specific fields. 
  2. Vaadin fields - Vaadin fields that can be used with Magnolia.
  3. Unsupported fields - Not clear why we specify what Vaadin fields NOT to use. The list of controls is not extensive, implying either that there are many more controls that can be added (in which case the form field tab and Vaadin fields tab are incomplete) or that the list of banned controls is incomplete.

Need to include information on using each control. How? What kind of information

 As we are using Vaadin controls, we analyzed the Vaadin approach to documentation them:

Vaadin approach

See: http://demo.vaadin.com/sampler Note that when the information is viewed this way, you get essentially what I would argue for in the Showcase app - a three column approach with headings that correspond to Control, Image, Description. The difference is that in Mag 5 we don't want to have click, jab to see the info.

...

All three are possible if proposed redesign is implemented.

Follow up. Documentation requirement.

If we are to add a link to Magnolia 5 that leads to our wiki or docu, the documentation requirements will need to be communicated clearly.