lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hoss Man (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SOLR-11032) Update solrj tutorial
Date Fri, 20 Oct 2017 16:57:00 GMT

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

Hoss Man commented on SOLR-11032:
---------------------------------

First off: big +1 from me on the idea of moving to using include-partial to pull in solrj
samples.  i love that this sort of thing is now possible with the ref-guide.

bq. The attached patch moves the Java snippets out from the using-solrj page, to build-able
examples that live in {{solr/solr-ref-guide/src/java}}. ...

i haven't looked at the patch in depth, but i would suggest that _instead_ of adding new,
isloated, examples that live in {{solr/solr-ref-guide/src/java}}, thes new code snippets belong
in tests that live in {{solr/solrj/src/test}}.

that would:
* keep the "PROS" listed (the solrj APIs can't be updated w/o the tests being updated)
* new PRO: pulling these snippets from actual junit tests means we can not only be confident
that they compile, but that they actually do what the doc says they'll do -- by adding asserts
after/outside the include tags verifying the expected outcome
* eliminate the only CONS: no need to change the build dependencies of the ref-guide
** building the ref guide won't _depend_ on building solrj, it will just trust that the snippets
must be valid because the solrj tests (presumably) pass
*** down the road, once we can more easily integrate the ref guide build directly into the
main build this assumption can go away -- but in the mean time it doesn't have to be a concern/issue/question
affecting these doc impreovements
** of course: the ref-guide build ican/should still fail if the "include" tags aren't found
in the references java file (or if the java test file gets removed/moved)
*** (I'm assuming asciidoctor gives an error on this? we should double check that)


> Update solrj tutorial
> ---------------------
>
>                 Key: SOLR-11032
>                 URL: https://issues.apache.org/jira/browse/SOLR-11032
>             Project: Solr
>          Issue Type: Task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation, SolrJ, website
>            Reporter: Karl Richter
>         Attachments: SOLR-11032.patch, SOLR-11032.patch
>
>
> The [solrj tutorial](https://wiki.apache.org/solr/Solrj) has the following issues:
>   * It refers to 1.4.0 whereas the current release is 6.x, some classes are deprecated
or no longer exist.
>   * Document-object-binding is a crucial feature [which should be working in the meantime](https://issues.apache.org/jira/browse/SOLR-1945)
and thus should be covered in the tutorial.



--
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


Mime
View raw message