Thanks for the explanation, Dan!

Martin Grigorov
Wicket Training and Consulting
https://twitter.com/mtgrigorov

On Fri, Mar 17, 2017 at 11:46 AM, Dan Haywood <[email protected]>
wrote:

> Not that difficult, Martin...  the installation is documented at [1]
>
> The only issue I foresee is the parsing of the "docfile" attribute to
> determine the corresponding path in the github repo.
>
> In the case of Isis our docs live under "adocs/documentation/..." and so
> the value of "docfile" is something like "
> C:/APACHE/isis-git-rw/adocs/documentation/src/main/
> asciidoc/migration-notes.adoc"
>
> The configuration properties in the pom.xml [2] specify
> "adocs/documentation" and "src/main/asciidoc" as 'anchors', and the regex
> in the extension [3] uses these to infer the rest of the path.
>
> So with a bit of luck you'll just need to register the extension and set
> the appropriate "improvethisdoc.xxx" properties.
>
> HTH
> Dan
>
>
> [1]
> https://github.com/incodehq/asciidoctor-extension-
> improvethisdoc#installation
> [2]
> https://github.com/apache/isis/blob/master/adocs/
> documentation/pom.xml#L220
>
> [3
> https://github.com/incodehq/asciidoctor-extension-
> improvethisdoc/blob/master/src/main/java/org/incode/
> asciidoctor/extensions/improvethisdoc/ImproveThisDocumentPostprocess
> or.java#L203
>
>
>
>
>
>
> On Fri, 17 Mar 2017 at 10:38 Martin Grigorov <[email protected]> wrote:
>
> > Hi,
> >
> > Do you think this would be useful for the guide ?
> >
> > The changes in Isis are rather big [3] and I am not sure how much work it
> > is to do the same for our guide.
> >
> > 3. https://issues.apache.org/jira/browse/ISIS-1594
> >
> >
> > Martin Grigorov
> > Wicket Training and Consulting
> > https://twitter.com/mtgrigorov
> >
> > ---------- Forwarded message ----------
> > From: Dan Haywood <[email protected]>
> > Date: Thu, Mar 16, 2017 at 7:09 PM
> > Subject: 'Edit' button on the generated docs on our website
> > To: users <[email protected]>
> > Cc: dev <[email protected]>
> >
> >
> > Hi folks,
> >
> > Just to bring to your attention, our Asciidoc-generated website now
> > features an 'Edit' button for each generated document (or subdocument);
> see
> > for example [1].  The magic is done by this asciidoc extension [2].
> >
> > When you click edit, you should end up at github editing the
> corresponding
> > file; hitting save will allow a pull request to be raised.
> >
> > If you try it out and hit any snags, do say.
> >
> > Thx
> > Dan
> >
> > [1] http://isis.apache.org/guides/ugfun.html#_ugfun_core-concepts
> > [2] https://github.com/incodehq/asciidoctor-extension-improvethisdoc
> >
>

Reply via email to