[ 
https://issues.apache.org/jira/browse/SOLR-11573?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16269456#comment-16269456
 ] 

ASF subversion and git services commented on SOLR-11573:
--------------------------------------------------------

Commit a3b46e45cf2b4e5ec7d73f6c39e08750654f1f2a in lucene-solr's branch 
refs/heads/branch_7x from [~ctargett]
[ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=a3b46e4 ]

SOLR-11573: Update meta-docs section on including code from non-adoc files


> 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
>            Assignee: Cassandra Targett
>            Priority: Trivial
>             Fix For: 7.2, master (8.0)
>
>         Attachments: SOLR-11573.patch, SOLR-11573_meta-docs.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]

Reply via email to