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

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

Commit f00adae954e6f1da6c7fb92718d0206046cfc96f in solr's branch 
refs/heads/branch_10x from Eric Pugh
[ https://gitbox.apache.org/repos/asf?p=solr.git;h=f00adae954e ]

SOLR-11574: Use executable java code in ref guide examples. (#3915)

Introduces some more sophisticated ways of verifying the output of the sample 
java code.   
Establishes some consistency in formatting and how we output.
Update to more modern Java practices.

> Extract more ref-guide Java snippets for building
> -------------------------------------------------
>
>                 Key: SOLR-11574
>                 URL: https://issues.apache.org/jira/browse/SOLR-11574
>             Project: Solr
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 8.0
>            Reporter: Jason Gerlowski
>            Assignee: Eric Pugh
>            Priority: Minor
>              Labels: pull-request-available
>         Attachments: SOLR-11574.patch
>
>          Time Spent: 1h 10m
>  Remaining Estimate: 0h
>
> As a part of SOLR-11032, all of the Java snippets in the "Using SolrJ" 
> ref-guide page were pulled out into separate unit-tests that are built and 
> run as part of the normal Solr build.  These snippets appear unchanged in the 
> ref-guide, but are now forcibly kept up-to-date by the build.
> It would be nice to expand this enforcement to other ref-guide pages that 
> contain Java snippets.
> The command {{grep -rIl "source,java" solr/solr-ref-guide/src}} shows all of 
> the ref-guide pages that contain Java snippets.  Currently, the list looks 
> like:
> {code}
> ./parallel-sql-interface.adoc
> ./pagination-of-results.adoc
> ./the-terms-component.adoc
> ./enabling-ssl.adoc
> ./transforming-result-documents.adoc
> ./uploading-data-with-solr-cell-using-apache-tika.adoc
> ./language-analysis.adoc
> ./kerberos-authentication-plugin.adoc
> ./stream-decorator-reference.adoc
> ./streaming-expressions.adoc
> ./ping.adoc
> ./basic-authentication-plugin.adoc 
> {code}
> This JIRA involves going through the Java snippets in the files listed above 
> and determining whether the snippet is a reasonable candidate for extraction. 
>  Maybe very few of these snippets make sense for extraction, but it's a 
> worthwhile investigation.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

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

Reply via email to