THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
- Go through the default configuration files line by line.
- Ensure that any documentation and explanation not yet in the Reference Guide are moved there. Delete any significant passage and replace them with Ref Guide links to ensure a single-source of truth (
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-11875 - Delete any default blocks that do not use parameter substitutions and point them to RefGuide for the section and to the API to get the real defaults as appropriate
- Delete legacy sections that 'no longer work' (e.g. jmx, possibly EditorialMarkerFactory)
- Delete workaround explanations for those migration from Solr prior to Solr 7? (Document them on RefGuide ?)
- Ensure that any documentation and explanation not yet in the Reference Guide are moved there. Delete any significant passage and replace them with Ref Guide links to ensure a single-source of truth (
- Review directory layouts current state
- Compare:
- Out-of-the-box for default install
- Out-of-the-box example install and hacks (e.g. in bin/solr)
- serviceinstall scripts
- docker setup (
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-11245 - Existing issues:
Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-13035 Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-6671
- Clarify naming for locations of:
- Static O/S global part of running solr
- Writable O/S global part of running solr (only pid file or more?)
- Server/Node level information (start.in.sh?, logs? configsets? solr.xml) - there may be several of this on a physical server, such as in cloud example. Or put all those in solr.home and have cores one level lower under coreRootDirectory (in solr.xml)
- Collection/Core level information (core.properties)
- Individual directories per core (conf, data) - some of these already can be in other locations
- Compare:
- Refactor example directory and associated commands to reduce magic
- This mainly affects log configuration and logging directory locations and figuring out what is the directory above solr home
- May also involve exploration about configsets and environmental override directories
- Create new examples (
, testable?Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-10329
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-11352 - Create a base learning config that is either based on default or has even simpler its own (
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-13652 - Setup new dataset (https://www.fakenamegenerator.com can generate 100k records with many interesting fields under CC license (https://creativecommons.org/licenses/by-sa/3.0/us/, similar to CC license used by films example already)
- Split records into different formats to demonstrate XML, CSV, multiple JSONs, nested records, etc
- Create a number of additive configurations+examples, that augment base configuration to demonstrate specific features with point precision
- Move non-essential schema definitions (e.g. languages) from default into alternative schema (new kitchen-sink). Should it be copy/paste XML or API commands, To Be Explored (
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-11033 - Update documentation to use new examples to demonstrate features that used to use older configsets
- Use short names for analyzer/filter/tokenizer wherever possible (
) - make sure they are easily discoverable in documentation as wellJira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-13691
- Create a base learning config that is either based on default or has even simpler its own (
- Rewrite Getting Started guide that focuses on simplest path through
- Start from standalone mode
- Explain what is happening with cross-references for more details (teach troubleshooting skills early)
- Use API as much as possible, but not at a cost of readability/comprehension
- Demonstrate recent APIs/features
- Build up to the cloud example
- Bigger changes that needs further discussion
- Delete ALL DIH examples in bulk - DONE (
,Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-14066
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-14783 - Delete Tika configuration and refer to the manual for configuration and warning (
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-13973 - Move schemaless mode into learning chain (
Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-14701
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-11741 - Delete (refactor) techproducts example and its files (but what about tests?)
- Delete Velocity example (
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-14065 - V2 vs V1 API for examples (V2 is not available for standalone mode in 8.6.1)
- post tool vs curl
- Interplay with Admin UI changes in progress (e.g. how much to leverage/demonstrate it)
- Neither default nor techproducts are realistic production schemes - a whole separate but related discussion (Jira exists?)
- It seems that even though Velocity/DIH/others have been deprecated, they have not actually been removed from code/documentation for 9.0 yet. Are there Jiras for that already?
- Delete ALL DIH examples in bulk - DONE (
- Other cleanup
- Fix the dead/legacy wiki.apache.org links (
)Jira server ASF JIRA serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key SOLR-14834
- Fix the dead/legacy wiki.apache.org links (
Compatibility, Deprecation, and Migration Plan
...