[CONF] Apache Solr Reference Guide > Core Admin and Configuring solr.xml

["Cassandra Targett (Confluence)" <co...@apache.org>]

Space: Apache Solr Reference Guide (https://cwiki.apache.org/confluence/display/solr)
Page: Core Admin and Configuring solr.xml (https://cwiki.apache.org/confluence/display/solr/Core+Admin+and+Configuring+solr.xml)
Comment: https://cwiki.apache.org/confluence/display/solr/Core+Admin+and+Configuring+solr.xml?focusedCommentId=33296160#comment-33296160

Comment added by Cassandra Targett:
---------------------------------------------------------------------

Erick Erickson asked me for some thoughts on this in the context of core discovery and the new role of solr.xml. There is a lot to cover here and to do it right content should cover these topics:

# the role of solr.xml in a standalone & solrcloud installation.
# the details of the new format: each parameter, allowed values and defaults.
## the role of core.properties should also be described in this context.
# the details of the old format (the content already on this page), with a big warning that it's going away.
# help for users who are upgrading to 4.4 and would like to transition to the new approach. They need to know what to change.

This page currently also covers CoreAdminHandler, and that should move to a new page as the options have grown and with all this other content it's buried. I have a gut feeling it shouldn't stay in the solr.xml section, but it could for this release since right now I don't have a great idea about where it could go.

Online documentation should have pages as short as practical, so splitting this into multiple pages within a section (similar to [Configuring solrconfig.xml] and child pages) makes the most sense in my opinion. (The PDF will put them back together as a book, so no need to worry about that.)

So, projecting some possible page names & the page hierarchy, with some notes on page content:

- "Solr Cores and solr.xml": Intro to cores and solr.xml, clearly defining the concepts. Provides links to all other pages with very brief (1-sentence or a few words) description of the content covered there. (PS: I'm leaving solr.xml in the page title so people know what's going to be covered - good for browsing, google-ability, etc.)
-- "Format of solr.xml": Real-ish example of a new-format solr.xml file (maybe exactly what's in {{example/solr}}). List and describe every parameter, whether it's in the example file or not - this can be a simple table or a more detailed description. I usually start with a table and then see how it works (see [Faceting] for an example of a page that has a table linking to a longer discussion of each param; see [The Standard Query Parser] for an example where a simple table was fine). Describe and show a real-ish example of core.properties, with description of possible parameters and defaults as appropriate.
-- "Legacy solr.xml Configuration": Basically pull the current content into this page. Add a big red warning (with the warning macro) to the top to say it is legacy
-- "Moving to the New solr.xml Format": Example (one to start is OK) of how someone would use a real-ish legacy solr.xml and transition to the new solr.xml/core.properties. Which params go in new solr.xml and which in core.properties? Which legacy params are not needed anymore?
-- "CoreAdminHandler Parameters and Usage": Pull the whole section about CoreAdminHandler on current page to this new page. Add handler calls as appropriate for 4.4; check examples for accuracy.

It's definitely possible that more splitting will be needed, but without doing this first part, it's hard to guess if it will entirely work this way. Expect that more structural changes will be needed as the first pass shapes up.



Stop watching space: https://cwiki.apache.org/confluence/users/removespacenotification.action?spaceKey=solr
Change email notification preferences: https://cwiki.apache.org/confluence/users/editmyemailsettings.action