[
https://issues.apache.org/jira/browse/SOLR-11574?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jason Gerlowski updated SOLR-11574:
-----------------------------------
Description:
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.
was:
As a part of SOLR-11526, 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.
> 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
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Affects Versions: master (8.0)
> Reporter: Jason Gerlowski
> Priority: Minor
>
> 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
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
