Re: [jdf-dev] cheatsheets in quickstarts/archetypes

On Thu, Jun 27, 2013 at 10:55:59AM +0100, Pete Muir wrote: > > On 27 Jun 2013, at 09:20, Max Rydahl Andersen <manderse(a)redhat.com&gt; wrote: > >> On Wed, Jun 26, 2013 at 11:38:55AM +0100, Pete Muir wrote: >>> Let's focus on the archetypes and quickstarts presented on JBoss Central to start with. Not sure how we can automate this. Max, any ideas? >> >> Actually, I guess a "dumb" conversion could just turn every section in readme.md files into a section in a cheetsheet....do >> we have a markdown parser/tnansformer somewhere we could tweek ? :) > > There are lots that create html. Not sure if there is one to convert to a cheatsheet. Is there a html->cheatsheet transformer? no. not that I know of. >> >> The output wouldn't be much value add but at least it wouldn't block the main UI of eclipse but instead be visible when browsing files >> which I think is a plus. > > +1 > > BTW do we have a cheatsheet tutorial or guide out there? First mail on this thread is me pointing to github, examples and urls on how to do them :) I even responded on JDF-199 where you also asked. Here it is again: http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.platform.doc... http://help.eclipse.org/galileo/topic/org.eclipse.platform.doc.isv/guide/... Example cheatsheet project at https://github.com/maxandersen/cheatsheet-helloworld /max >> >> /max >> >>> On 25 Jun 2013, at 17:08, Sande Gilda <sgilda(a)redhat.com&gt; wrote: >>> >>>> There is an outstanding pull for a cheatsheet for the kitchensink quickstart here: https://github.com/jboss-jdf/jboss-as-quickstart/pull/363 >>>> >>>> Max, did you see Pete's comment in that pull: https://github.com/jboss-jdf/jboss-as-quickstart/pull/363#issuecomment-11... I like the idea of adding the steps to the CONTRIBUTING.md file. Would you be able to provide me with the steps necessary to build a cheatsheet? I'll be glad to update the CONTRIBUTING.md file. >>>> >>>> Pete, I don't really expect to get much support from the contributors of the early quickstarts at this point. I haven't had much luck when I've gone back with questions and some contributors are no longer around. We have over 100 quickstarts now, so if we need to create a cheatsheet for each of them, it would be nice if we could automate part of the process, at least the basic template. >>>> >>>> On 06/25/2013 11:19 AM, Pete Muir wrote: >>>>> 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&gt; >>>>> 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 >>>>> >>>>> _______________________________________________ >>>>> jdf-dev mailing list >>>>> >>>>> jdf-dev(a)lists.jboss.org >>>>> https://lists.jboss.org/mailman/listinfo/jdf-dev >>>> >>> > > > _______________________________________________ > jdf-dev mailing list > jdf-dev(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/jdf-dev