mirror of
https://github.com/apache/lucene.git
synced 2025-02-07 10:38:40 +00:00
6d71a0aced
* Creating Scripting contrib module to centralize the less secure code related to scripts. * tweak the changelog and update notice to explain why the name changed and the security posture thinking * the test script happens to be a currency.xml, which made me think we were doing something specific to currency types, but instead any xml formatted file will suffice for the test. * Update solr/contrib/scripting/src/java/org/apache/solr/scripting/update/ScriptUpdateProcessorFactory.java * Update solr/contrib/scripting/src/java/org/apache/solr/scripting/update/package-info.java * drop the ing, and be more specific on the name of the ref guide page * comment out the script update chain. The sample techproducts configSet is used by many of the solr unit tests, and by default doesn't have access to the jar file in the contrib module. This is commented out, similar to how the lang contrib is. * using a Mock for the script processor in order to keep the trusted configSets tests all together. * tweak since we are using a mock script processor Co-authored-by: David Smiley <dsmiley@apache.org>
= Solr Ref Guide // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. This is the source for the Solr Reference Guide. Raw content is stored in Asciidoc (`.adoc`) formatted files in the `src/` directory. == Prerequisites for Building These files are processed with AsciiDoctor in 2 different ways: * HTML version, using Jekyll: ** `Ruby` (v2.3 or higher) ** The following gems must be installed: *** `jekyll`: v3.5, not v4.x. Use `gem install jekyll --force --version 3.5.0` to force install of v3.5.0. *** `jekyll-asciidoc`: v2.1 or higher; latest version (3.0.0) is fine. Use `gem install jekyll-asciidoc` to install. *** `slim`: v3.0 or higher; latest version (4.0.1) is fine. Use `gem install slim` to install. *** `tilt`: v1.0 or higher; latest version (2.0.10) is fine. Use `gem install tilt` to install. *** `concurrent-ruby`: v1.0 or higher; latest version (1.1.5) is fine. Use `gem install concurrent-ruby` to install. == Building the Guide For details on building the ref guide, see `gradlew tasks`, the `Documentation Tasks` section. There are currently four available targets: * `gradlew buildSite`: Builds an HTML Site w/Jekyll and verifies the anchors+links are valid * `gradlew documentation`: Generate all documentation * `gradlew javadoc`: Generates Javadoc API documentation for the main source code. * `gradlew renderJavadoc`: Generates Javadoc API documentation for the main source code. This directly invokes javadoc tool. * `gradlew renderSiteJavadoc`: Generates Javadoc API documentation for the site (relative links). The output of all builds will be located in `../solr-ref-guide/build`. == Key Directories Key directories to be aware of: * `src` - where all human edited `*.adoc` files related to the Guide live, as well as various configuration, theme, and template files. * `tools` - custom Java code for parsing metadata in our `src/*.adoc` files to produce some `_data/` files for site navigation purposes. * `../solr-ref-guide/build/content` - a copy of the `src` dir generated by gradle where: ** `*.template` files are processed to replace gradle (TODO CHECK!) properties with their runtime values ** some `../solr-ref-guide/build/content/_data` files are generated by our java tools based header attributes from each of the `*.adoc` files * `../solr-ref-guide/build/html-site` - HTML generated version of the ref guide See the additional documentation in `src/metadocs` for more information about how to edit files, build for releases, or modifying any Jekyll templates.