arafalov opened a new pull request #1921:
URL: https://github.com/apache/lucene-solr/pull/1921


   # Description
   
   The information in the Guide was not flowing and confusing, the sections on 
defaults were as if they were for Search Handlers only, not for all and there 
were not enough forward references to actually understand the available options.
   
   Additionally, the shipped solrconfig.xml information was completely out of 
date and even misleading (by pretending to be the source of truth) and 
additional information links were going to the wiki, which were either out of 
date or completely dead.
   
   # Solution
   
   Completely refactor the relevant Ref Guide page (git does not even show diff 
by default). 
   Introduced a lot more cross-referencing and forward-referencing, including 
to URPs as parallel to Search Components.
   
   Pointed solrconfig.xml links to RefGuide (latest-version redirects) and 
removed sections that were duplicating Ref Guide content (and falling out of 
sync).
   
   # Tests
   
   The changes were all documentation, but I double-checked that both 
configsets are still usable after changes made (no XML errors).
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [X] I have reviewed the guidelines for [How to 
Contribute](https://wiki.apache.org/solr/HowToContribute) 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)
   - [X] I have developed this patch against the `master` branch.
   - [X] I have run `./gradlew check`.
   - [X] I have added documentation for the [Ref 
Guide](https://github.com/apache/lucene-solr/tree/master/solr/solr-ref-guide) 
(for Solr changes only).
   
   


----------------------------------------------------------------
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.

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



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to