Re: [jira] [Resolved] (DELTASPIKE-898) Make documentation structure more comprehensible
On 13 May 2015 at 09:43, Ron Smeral wrote: > Hi Dan, > > the monitor.rb sure might come in handy, thanks! > > I was struggling to find a resonable way to write asciidoc. I currently > settled on Atom with asciidoc plugin which is still somewhat clunky, or > the asciidocfx editor. Both have a live preview feature, so I only build > the docs once I'm done editing just to check if links work. I admit > though that the monitor.rb workflow may be still faster. > > yes, I've tried both of those editors, but am finding that monitor.rb works best for me. I just alt-tab between IntelliJ for editing and Chrome for viewing. > The only feature I miss is some kind of an "outline" or "structure" > view, showing the structure of the document (at least the headers) for > easier navigation in long documents. Haven't yet found an editor which > would do this for asciidoc. > > Yup, I miss that too. If you come across one, do say. Cheers Dan > > Thanks, > > Ron > > > On 13.5.2015 07:52, Dan Haywood wrote: > > Ron/others, > > > > Great to see this new Asciidoc work going on. > > > > In case you missed it... to improve workflow I developed a little > > "monitor.rb" Ruby script that will automatically regenerate all .adoc's, > > also serves up the files and monitors changes. It makes for a really > nice > > workflow. > > > > For details, see [1] (corresponds directly to your own [2]). > > > > Feel free to rip-off/improve. > > > > Cheers > > Dan > > > > [1] https://github.com/apache/isis/tree/master/adocs/documentation > > [2] https://github.com/apache/deltaspike/tree/master/documentation > > > > > > On 12 May 2015 at 19:49, Ron Smeral (JIRA) wrote: > > > >> > >> [ > >> > https://issues.apache.org/jira/browse/DELTASPIKE-898?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel > >> ] > >> > >> Ron Smeral resolved DELTASPIKE-898. > >> --- > >> Resolution: Fixed > >> > >> Pushed and published. > >> > >> > >> > https://git-wip-us.apache.org/repos/asf?p=deltaspike.git;a=commit;h=e67d64a247d110db8e4f51ba8eb403e28c05710f > >> > >>> Make documentation structure more comprehensible > >>> > >>> > >>> Key: DELTASPIKE-898 > >>> URL: > >> https://issues.apache.org/jira/browse/DELTASPIKE-898 > >>> Project: DeltaSpike > >>> Issue Type: Improvement > >>> Components: Documentation > >>>Reporter: Ron Smeral > >>>Assignee: Ron Smeral > >>>Priority: Minor > >>> > >>> Add/remove/adjust headings in documentation so that the TOC shows the > >> structure of the document immediately without hiding it. > >> > >> > >> > >> -- > >> This message was sent by Atlassian JIRA > >> (v6.3.4#6332) > >> > > > > -- > Ron Smeral > JBoss Quality Engineer > Brno >
Re: [jira] [Resolved] (DELTASPIKE-898) Make documentation structure more comprehensible
Hi Dan, the monitor.rb sure might come in handy, thanks! I was struggling to find a resonable way to write asciidoc. I currently settled on Atom with asciidoc plugin which is still somewhat clunky, or the asciidocfx editor. Both have a live preview feature, so I only build the docs once I'm done editing just to check if links work. I admit though that the monitor.rb workflow may be still faster. The only feature I miss is some kind of an "outline" or "structure" view, showing the structure of the document (at least the headers) for easier navigation in long documents. Haven't yet found an editor which would do this for asciidoc. Thanks, Ron On 13.5.2015 07:52, Dan Haywood wrote: > Ron/others, > > Great to see this new Asciidoc work going on. > > In case you missed it... to improve workflow I developed a little > "monitor.rb" Ruby script that will automatically regenerate all .adoc's, > also serves up the files and monitors changes. It makes for a really nice > workflow. > > For details, see [1] (corresponds directly to your own [2]). > > Feel free to rip-off/improve. > > Cheers > Dan > > [1] https://github.com/apache/isis/tree/master/adocs/documentation > [2] https://github.com/apache/deltaspike/tree/master/documentation > > > On 12 May 2015 at 19:49, Ron Smeral (JIRA) wrote: > >> >> [ >> https://issues.apache.org/jira/browse/DELTASPIKE-898?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel >> ] >> >> Ron Smeral resolved DELTASPIKE-898. >> --- >> Resolution: Fixed >> >> Pushed and published. >> >> >> https://git-wip-us.apache.org/repos/asf?p=deltaspike.git;a=commit;h=e67d64a247d110db8e4f51ba8eb403e28c05710f >> >>> Make documentation structure more comprehensible >>> >>> >>> Key: DELTASPIKE-898 >>> URL: >> https://issues.apache.org/jira/browse/DELTASPIKE-898 >>> Project: DeltaSpike >>> Issue Type: Improvement >>> Components: Documentation >>>Reporter: Ron Smeral >>>Assignee: Ron Smeral >>>Priority: Minor >>> >>> Add/remove/adjust headings in documentation so that the TOC shows the >> structure of the document immediately without hiding it. >> >> >> >> -- >> This message was sent by Atlassian JIRA >> (v6.3.4#6332) >> > -- Ron Smeral JBoss Quality Engineer Brno
Re: [jira] [Resolved] (DELTASPIKE-898) Make documentation structure more comprehensible
Ron/others, Great to see this new Asciidoc work going on. In case you missed it... to improve workflow I developed a little "monitor.rb" Ruby script that will automatically regenerate all .adoc's, also serves up the files and monitors changes. It makes for a really nice workflow. For details, see [1] (corresponds directly to your own [2]). Feel free to rip-off/improve. Cheers Dan [1] https://github.com/apache/isis/tree/master/adocs/documentation [2] https://github.com/apache/deltaspike/tree/master/documentation On 12 May 2015 at 19:49, Ron Smeral (JIRA) wrote: > > [ > https://issues.apache.org/jira/browse/DELTASPIKE-898?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel > ] > > Ron Smeral resolved DELTASPIKE-898. > --- > Resolution: Fixed > > Pushed and published. > > > https://git-wip-us.apache.org/repos/asf?p=deltaspike.git;a=commit;h=e67d64a247d110db8e4f51ba8eb403e28c05710f > > > Make documentation structure more comprehensible > > > > > > Key: DELTASPIKE-898 > > URL: > https://issues.apache.org/jira/browse/DELTASPIKE-898 > > Project: DeltaSpike > > Issue Type: Improvement > > Components: Documentation > >Reporter: Ron Smeral > >Assignee: Ron Smeral > >Priority: Minor > > > > Add/remove/adjust headings in documentation so that the TOC shows the > structure of the document immediately without hiding it. > > > > -- > This message was sent by Atlassian JIRA > (v6.3.4#6332) >
[jira] [Resolved] (DELTASPIKE-898) Make documentation structure more comprehensible
[ https://issues.apache.org/jira/browse/DELTASPIKE-898?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Ron Smeral resolved DELTASPIKE-898. --- Resolution: Fixed Pushed and published. https://git-wip-us.apache.org/repos/asf?p=deltaspike.git;a=commit;h=e67d64a247d110db8e4f51ba8eb403e28c05710f > Make documentation structure more comprehensible > > > Key: DELTASPIKE-898 > URL: https://issues.apache.org/jira/browse/DELTASPIKE-898 > Project: DeltaSpike > Issue Type: Improvement > Components: Documentation >Reporter: Ron Smeral >Assignee: Ron Smeral >Priority: Minor > > Add/remove/adjust headings in documentation so that the TOC shows the > structure of the document immediately without hiding it. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
