[
https://issues.apache.org/jira/browse/SOLR-11573?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16259482#comment-16259482
]
Cassandra Targett commented on SOLR-11573:
------------------------------------------
bq. I had to turn "safe-mode" off in the Jekyll config....Anyone have any
context on the scope of this setting?
This is already disabled in build.xml for the PDF generation, and I think it's
just an oversight that it's not disabled in the HTML config also. One of the
things "unsafe" mode allows you to do is include files - the {{include}}
directive only works in certain circumstances unless it's in "unsafe" (which is
why safe mode is disabled for the PDF).
This section of the Asciidoctor User Manual describes what is and isn't allowed
with each mode:
http://asciidoctor.org/docs/user-manual/#running-asciidoctor-securely. I
personally think the risk is low for our purposes.
> 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: [email protected]
For additional commands, e-mail: [email protected]
