Opened 8 years ago

Last modified 3 years ago

#3082 released task (fixed)

http://vaadin.com/eclipse need to be documented thoroughly

Reported by: fredu Owned by: Marko Gronroos
Priority: blocker Milestone: Book of Vaadin 6 Edition
Component: Web-site Version: 6.0.0
Keywords: Cc:
Depends on:
Workaround:
Verified:
Fv: no

Description

The Book of Vaadin refers t http://vaadin.com/eclipse for up-to-date info on how to use the eclipse-plugin. But currently it only states how to install the plugin. Need instructions on how to access the manual. Create own components, how to use the WYSIWYG etc. Just pictures with a few words next to them is enough.

Change history (12)

comment:1 Changed 8 years ago by Joonas Lehtinen

IMO this documentation belongs to "Book of Vaadin". On vaadin.com/eclipse we might have quick step-by-step summary of how to install _AND_ links to book of vaadin on how to use different features.

comment:2 Changed 8 years ago by Marko Gronroos

  • hours_left set to 40
  • Milestone changed from Documentation backlog to Book of Vaadin 6 Edition
  • Owner changed from Joonas Lehtinen to Marko Gronroos
  • Status changed from new to accepted

comment:3 Changed 8 years ago by Marko Gronroos

  • Resolution set to fixed
  • Status changed from accepted to closed

Done for the most relevant parts in [8498], [8504], [8526], [8527], and [8542]. Probably needs review.

comment:4 Changed 8 years ago by fredu

  • Resolution fixed deleted
  • Status changed from closed to reopened

Would it be possible to update the info on the webpage as well?

At least add pointers to more thorough documentation to http://vaadin.com/eclipse because that is what people find before they ever even look at the book...

comment:5 Changed 8 years ago by Marko Gronroos

Hmm, who's supposed to maintain the page on the website? Maybe reassign or have a separate ticket for it?

comment:6 Changed 8 years ago by Joonas Lehtinen

I wrote the original /eclipse page. Please file a ticket with info on what should be updated.

comment:7 Changed 8 years ago by Joonas Lehtinen

Just to add the obvious - vaadin.com/eclipse is not supposed to be a comprehensive documentation of the plugin. It is just a starting point for installing the plugin. Thus I would like to see _less_ info on that page - not more. Short bullet point list on what to do (step by step) is better that long page with more documentation on the features.

Maybe the real question is then - what should we remove? And add a link to book for more comprehensive documentation....

comment:8 Changed 8 years ago by fredu

Also remove the comment from the book's preface that states that up-to-date info is found on vaadin.com/eclipse in case that is not up-to-date info.

Add to the webpage that the WYSIWYG will only work on Vaadin CustomComponents (at least in practice although you naturally also can write @autogenerated etc)...

... took me a while to understand why my homemade classes didn't have the WYSIWYG option.

With this addition and the change in the preface we can IMO close this ticket.

comment:9 Changed 8 years ago by Marko Gronroos

The note has already been removed from the Preface, as the passage mentioned things that were not covered in the book, but they are now.

comment:10 Changed 8 years ago by Joonas Lehtinen

  • Resolution set to fixed
  • Status changed from reopened to closed

comment:11 Changed 4 years ago by Artur Signell

  • Fv unset

comment:12 Changed 3 years ago by Artur Signell

  • Status changed from closed to released
Note: See TracTickets for help on using tickets.