gus-asf commented on code in PR #1130:
URL: https://github.com/apache/solr/pull/1130#discussion_r1006112851


##########
solr/solr-ref-guide/modules/getting-started/pages/introduction.adoc:
##########
@@ -16,28 +16,32 @@
 // specific language governing permissions and limitations
 // under the License.
 
-Solr is a search server built on top of https://lucene.apache.org[Apache 
Lucene], an open source, Java-based, information retrieval library.
-It is designed to drive powerful document retrieval applications - wherever 
you need to serve data to users based on their queries, Solr can work for you.
+Apache^TM^ Solr is a search server built on top of 
https://lucene.apache.org[Apache Lucene^TM^], an open source, Java-based, 
information retrieval library.
+Solr is designed to drive powerful document retrieval or analytical 
applications involving unstructured data, semi-structured data or a mix of 
unstructured and structured data.
+It also has secondary support for limited relational, graph, statistical, data 
analysis or storage related use cases.
+Since Solr is Apache 2.0 licensed open source software designed for 
extensibility, it gives you the freedom to adapt or optimize it for almost any 
commercial or non-commercial use case.
 
-Solr is based on open standards and it is highly extensible.
-Solr queries are simple HTTP request URLs and the response is a structured 
document: mainly JSON, but it could also be XML, CSV, or other formats.
-This means that a wide variety of clients will be able to use Solr, from other 
web applications to browser clients, rich client applications, and mobile 
devices.
-Any platform capable of HTTP can talk to Solr.
-See xref:deployment-guide:client-apis.adoc[] for details on client APIs.
+Solr's xref:query-guide:query-syntax-and-parsers.adoc[query syntax and 
parsers] offer support for everything from the simplest keyword searching 
through to complex queries on multiple fields and 
xref:query-guide:faceting.adoc[faceted] search results.
+xref:query-guide:collapse-and-expand-results.adoc[Collapsing] and 
xref:query-guide:result-clustering.adoc[clustering] results offer compelling 
features for e-commerce and storefronts.
+Streaming calculations across large sets of text documents are available via 
xref:query-guide:streaming-expressions.adoc[streaming expressions].
+Powerful xref:query-guide:math-expressions.adoc[math expressions] provide the 
backbone for advanced analysis and predictive analytics use cases.
 
-Flexible schema configurations allow nearly any type of data to be stored in 
Solr.
-The xref:indexing-guide:schema-elements.adoc[] has more details on these 
options.
+Advanced relevancy tuning is also supported.
+Solr provides access to almost all of Lucene's text analysis features 
including tokenization, stemming, synonyms and much more, allowing you to tune 
relevancy based on knowledge of your users and your domain.
+Solr even allows for customization of relevancy via machine learning using the 
xref:query-guide:learning-to-rank.adoc[] feature.
 
-Solr offers support for the simplest keyword searching through to complex 
queries on multiple fields and faceted search results.
-Collapsing and clustering results offer compelling features for e-commerce and 
storefronts.
-Powerful math expressions provide the backbone for advanced analytics use 
cases.
-The xref:query-guide:query-syntax-and-parsers.adoc[] has more information 
about searching and queries.
+Queries are transmitted to Solr via HTTP 1.0, 1.1 or 2.0 requests and the 
response is typically a list of structured document descriptors.
+In the classic example, 10 descriptors are returned, each including a URL to 
locate the document (often rendered as "10 blue links"). However, Solr can go 
far beyond document locators and many other types of document metadata might 
also be included.  Flexible schema configurations allow nearly any type of 
metadata to be associated with a document indexed in Solr.

Review Comment:
   Although "document" is the traditional term, it is quite misleading if you 
aren't familiar with search. A lay person hearing that a "document" is returned 
would think that the entire set of bits that went in are coming back out. While 
that could be achieved and in rare cases is what's desired, it's abnormal and 
in many cases it is bad design, so I specifically was careful not to use 
"document" as a noun here. In most cases what we return is a much shorter 
"pointer plus metadata". Descriptor seemed apropos but if you can think of a 
more elegant word that clearly communicates the same thing to a reader that has 
never implemented search, I'm all ears.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


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

Reply via email to