You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Jason Gerlowski (JIRA)" <ji...@apache.org> on 2017/10/29 22:12:00 UTC
[jira] [Commented] (SOLR-11573) Add live-preview support for
ref-guide files using asciidoc-includes
[ https://issues.apache.org/jira/browse/SOLR-11573?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16224225#comment-16224225 ]
Jason Gerlowski commented on SOLR-11573:
----------------------------------------
This could be as simple/lightweight as including instructions for copying conf-changes for Atom in the ref-guide Readme (or in {{meta-docs}} if they belong more there).
Another option would involve creating an {{ant atom}} target which either reconfigures Atom's included-files path. This follows the pattern established by the existing {{ant eclipse}} and {{ant intellij}} targets.
There might be other better solutions too, these are just two options.
> 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
>
> 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-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org