[
https://issues.apache.org/jira/browse/SOLR-11573?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jason Gerlowski updated SOLR-11573:
---
Attachment: SOLR-11573.patch
Thanks for doing some digging on this Hoss.
I was able to get the live-preview working pretty easily with the attribute
setup you suggested. This allows us to drop the Java-file copying too.
The only caveat is that for asciidoctor to access the included-files (which are
outside of its chroot), I had to turn "safe-mode" off in the Jekyll config.
I'm still poking around the asciidoctor docs to see what exactly this setting
controls. It _seems_ innocent to disable, given how we're using asciidoctor,
but I'm still double checking. Anyone have any context on the scope of this
setting?
Anyway, if the property ends up being safe to leave disabled, then this patch
is ready for review. Precommit passes, fwiw.
> Add live-preview support for ref-guide files using asciidoc-includes
>
>
> Key: SOLR-11573
> URL: https://issues.apache.org/jira/browse/SOLR-11573
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
>Affects Versions: master (8.0)
>Reporter: Jason Gerlowski
>Priority: Trivial
> Attachments: SOLR-11573.patch
>
>
> With the completion of SOLR-11032, the "Using SolrJ" page in the ref-guide
> now imports some Java code snippets from an external file. This is done to
> allow the snippets appearing in the documentation to be compiled/run as part
> of the build...so they will always stay up to date.
> During the ref-guide build, this external file is copied into the ref-guide
> build directory so that the references to it can be resolved. However,
> anyone using the "live preview" feature of modern asciidoc editors (Atom,
> etc.), will find that the snippets don't appear in their live-preview.
> Depending on your editor, a discrete error message may be displayed.
> It would be nice to fix this "papercut" in usability, or at least provide a
> workaround. The easier we can make it to improve the docs, the better.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
