SOLR-16295: Modernize helm-chart project description #721
Conversation
helm/solr/README.md
Outdated
| Solr is the blazing fast, open source, multi-modal search platform built on Apache Lucene. Its full-text, vector, and geospatial search power many of the world's largest organizations. | ||
| Major features include: Kubernetes and docker integration; streaming and analytics; and highlighting, faceting, and spellchecking. |
There was a problem hiding this comment.
the second sentence starts with "Major features" yet the first sentence listed some. Perhaps the first should list broad categories and thus shouldn't include geospatial (leave for 2nd). Should list analytics up there.
There was a problem hiding this comment.
In my mind at least, there's a distinction between the lists in each sentence. The first sentence (and its list) is focused narrowly on the "types" of search that Solr supports: full-text, vector, etc. The second sentence is a more general grab-bag, to list things users might care about that aren't strictly search-related.
Given that distinction - I guess i could imagine putting "analytics" (or "analytics search") in the first sentence if you feel strongly about it? But I probably wouldn't move "geospatial" to the second sentence, unless we want to ditch my distinction altogether.
There was a problem hiding this comment.
If I understand you (I might not!), you seem to want the first sentence to be scoped to search. Why constrain that; why not analytics? Arguably vector is an area separate from full-text as well (and I'm glad you list it in the first sentence).
There was a problem hiding this comment.
If I understand you (I might not!), you seem to want the first sentence to be scoped to search.
I do, yep. In the first sentence I'm trying to highlight the different types of search we support. "Full-text search", "geospatial search", and "vector search" all seemed to fit.
"Analytics" IMO is a little more borderline - I don't often hear people talk about "analytics search" the same way I hear some of those other terms. But as I said above, I'm happy to swap things around given your feedback.
There was a problem hiding this comment.
Alright, updated. I've also made similar tweaks to the "main repo" PR here, where necessary.
Feedback comes primarily from: apache/solr#2692
Comment on JIRA ticket about 'multi-modal' being redundant.
Other commits materialized on JIRA about liking the term 'multi-modal'.
Description
Solr uses variations of the blurb below to describe itself on solr.apache.org, in the ref-guide, READMEs, etc:
This has served us well for years, but a few reasons call for a refresh:
Solution
This PR (along with accompanying changes to the main repo and website) updates and unifies the language the project uses to describe itself.