lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hoss Man (JIRA)" <>
Subject [jira] [Updated] (SOLR-11573) Add live-preview support for ref-guide files using asciidoc-includes
Date Wed, 22 Nov 2017 23:49:01 GMT


Hoss Man updated SOLR-11573:
    Attachment: SOLR-11573_meta-docs.patch

Cassandra: Here's a stab at a patch for the meta-docs ... not sure i like how it flows, but
it might save you some time? Feel free to modify/ignore/commit as you see fit.

> Add live-preview support for ref-guide files using asciidoc-includes
> --------------------------------------------------------------------
>                 Key: SOLR-11573
>                 URL:
>             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 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

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message