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

Cassandra Targett commented on SOLR-8521:
-----------------------------------------

bq. Live documentation feels like the best fit for this. Regardless of what 
Solr version people are using, it seems like they tend to go look at the latest 
version of cwiki anyway. If that's the case, the question may just boil down 
to: do we want to put this somewhere on the wiki that doesn't get serialized to 
a PDF?

We have no model today for documentation that is "online only". The online 
version of the Ref Guide is always a draft for the next release; the real Ref 
Guide is actually the PDF. I happen to agree with you that most users would 
prefer an online version instead of a giant PDF, but there are reasons why it 
isn't like that and real obstacles to making it like that. 

I get your overall point - a full screenshot-by-screenshot walkthrough is 
somewhat heavy in the PDF and works better in an online version, but I don't 
see the harm in adding a couple of screenshots using one client as an example 
with the way we've got things today. The docs will need to avoid any 
client-specific details anyway, at least in a section that applies to all 
clients, even if there is a section that covers a specific client in more 
detail.

> Add documentation for how to use Solr JDBC driver with SQL client like DB 
> Visualizer
> ------------------------------------------------------------------------------------
>
>                 Key: SOLR-8521
>                 URL: https://issues.apache.org/jira/browse/SOLR-8521
>             Project: Solr
>          Issue Type: Sub-task
>          Components: documentation, SolrJ
>    Affects Versions: master
>            Reporter: Kevin Risden
>         Attachments: solr_jdbc_dbvisualizer_20160203.pdf
>
>
> Currently this requires the following:
> * a JDBC SQL client program (like DBVisualizer or SQuirrelSQL)
> * all jars from solr/dist/solrj-lib/* to be on the SQL client classpath
> * solr/dist/solr-solrj-6.0.0-SNAPSHOT.jar on the SQL client classpath
> * a valid JDBC connection string (like 
> jdbc:solr://SOLR_ZK_CONNECTION_STRING?collection=COLLECTION_NAME)
> * without SOLR-8213, the username/password supplied by the SQL client will be 
> ignored.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to