You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "gerlowskija (via GitHub)" <gi...@apache.org> on 2024/09/03 19:32:28 UTC

[PR] Modernize and standardize project description [solr]

gerlowskija opened a new pull request, #2692:
URL: https://github.com/apache/solr/pull/2692

   https://issues.apache.org/jira/browse/SOLR-16295
   
   # Description
   
   Solr uses variations of the blurb below to describe itself on solr.apache.org, in the ref-guide, READMEs, etc:
   
   > Solr is the popular, blazing-fast, open source enterprise search platform built on Apache Lucene [...]
   
   This has served us well for years, but a few reasons call for a refresh:
   
   1. Copies of this description have varied apart over time and need realigned
   2. The description misses (or underplays) some of Solr's newer features (e.g. vector search)
   3. Longer forms of the description emphasize features that aren't meaningful differentiators (e.g. XML-based APIs, scalability) in today's tech landscape.
   
   # Solution
   
   This PR (along with accompanying changes to the operator and website) updates and unifies the language the project uses to describe itself.
    
   # Tests
   
   N/A - documentation change only.
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [x] I have reviewed the guidelines for [How to Contribute](https://github.com/apache/solr/blob/main/CONTRIBUTING.md) and my code conforms to the standards described there to the best of my ability.
   - [x] I have created a Jira issue and added the issue ID to my pull request title.
   - [x] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
   - [x] I have developed this patch against the `main` branch.
   - [ ] I have run `./gradlew check`.
   - [x] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
   


-- 
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: issues-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] SOLR-16295: Modernize and standardize project description [solr]

Posted by "janhoy (via GitHub)" <gi...@apache.org>.
janhoy commented on PR #2692:
URL: https://github.com/apache/solr/pull/2692#issuecomment-2329174881

   I'm not a native english speaker, but I personally liked the alternative flow. Use it as input, this is subjective.


-- 
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: issues-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] SOLR-16295: Modernize and standardize project description [solr]

Posted by "gerlowskija (via GitHub)" <gi...@apache.org>.
gerlowskija commented on PR #2692:
URL: https://github.com/apache/solr/pull/2692#issuecomment-2328778427

   Do you agree with ChatGPT on those suggestions @janhoy ?
   
   Some I like and will take as-is.  Others I'm more conflicted on, and am tempted to ignore if it's "just" a computer suggestion that you don't also agree with.  Particularly:
   1. I don't see "open source" hyphenated [on the OSI's website](https://opensource.org/), and [Google's "Comm's Guide"](https://opensource.google/documentation/reference/comms/style-guide) actively advises against it.
   2. IMO the flow isn't improved by adding "as well as"
   
   My sense of what "flows" is obviously subjective, but I'll still take my hunch on that if it's "just" The Algorithm telling me otherwise, and not another human.


-- 
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: issues-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] SOLR-16295: Modernize and standardize project description [solr]

Posted by "gerlowskija (via GitHub)" <gi...@apache.org>.
gerlowskija merged PR #2692:
URL: https://github.com/apache/solr/pull/2692


-- 
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: issues-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org