Sande, Rafael, could you start brainstorming on how we add cheat sheets to all archetypes
and quickstarts?
I recommend we create a simple (e.g. 5 step) process for doing this (and review the hell
out of this, make sure it's foolproof) then reach out to all the original authors, and
ask them to go the extra mile and send in the cheatsheet.
On 25 Jun 2013, at 15:54, Max Rydahl Andersen <manderse(a)redhat.com> wrote:
Hi,
We've got this issue
https://issues.jboss.org/browse/JBDS-2557 and
https://issues.jboss.org/browse/JDF-199 open for a while.
Main gist is to use eclipse cheatsheets where possible for quickstarts and archetypes
since
they can be more interactive/guiding of the user.
From talking with Pete, he said he would prefer not to spend time on this before
a simple import of a quickstart from disk (not using JBoss Central) could open these
quickstarts.
Thus in Beta1 and Beta2 of JBoss Tools we added a few things to make this happen + some
documentation.
They are illustrated here:
http://docs.jboss.org/tools/whatsnew/examples/examples-news-4.1.0.Beta1.html
Basically:
A) There is now an option for showing cheatsheets if a project being opened has
.cheatsheet.xml or cheatsheet.xml in the root of the project.
(Beta1 had it default off for testing, in Beta2 we've enabled it by default)
B) We've made it so you can right click on a cheatsheet.xml file or a project and use
"Show In > Cheat sheets" for testing and for the case where
the user have *not* enabled the autoopen.
C) We've added two cheatsheets commands to make it easier to script for hightlighting
things in the sourrouding project.
Together with this is a screenshot showing how this works:
http://screencast.com/t/gK5JggVU
plus I created
https://github.com/maxandersen/cheatsheet-helloworld which if you import
it in jbosstools Beta2 will open it s cheatsheet.xml and show the basics.
I hope this is sufficient now to get started on this.
I don't think *all* quickstarts should have cheatsheets, but I think it would be
interesting to add for those where it can be used to enhance the explanations found in the
readme.md files.
Let me know if questions, and if we can help more in getting you started on writing
these.
p.s. there is a cheetsheet.xml editor in eclipse, its great to get started with and
browse for other good commands to use, but I suggest editing by hand since
the visual editor does seem to reformat/edit at bit too agressively.
/max
_______________________________________________
jdf-dev mailing list
jdf-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jdf-dev