dsmiley commented on a change in pull request #1450: URL: https://github.com/apache/lucene-solr/pull/1450#discussion_r414110471
########## File path: solr/example/files/README.md ########## @@ -111,38 +120,46 @@ For further explanations, see the frequently asked questions at the end of the g * Another way to query the index is by manipulating the URL in your address bar once in the browse view. * i.e. : [http://localhost:8983/solr/files/browse?q=Lucene](http://localhost:8983/solr/files/browse?q=Lucene) -<hr> -##FAQs + +## FAQs * Why use -d when creating a core? * -d specifies a specific configuration to use. This example as a configuration tuned for indexing and query rich text files. * How do I delete a core? - * To delete a core (i.e. files), you can enter the following in your command shell: - bin/solr delete -c files - - * You should see the following output: + * To delete a core (i.e. files), you can enter the following in your command shell: - Deleting core 'files' using command: - http://localhost:8983/solr/admin/cores?action=UNLOAD&core=files&deleteIndex=true&deleteDataDir=true&deleteInstanceDir=true + ``` + bin/solr delete -c files + ``` + + * You should see the following output: + + Deleting core 'files' using command: + + ``` + http://localhost:8983/solr/admin/cores?action=UNLOAD&core=files&deleteIndex=true&deleteDataDir=true&deleteInstanceDir=true - {"responseHeader":{ - "status":0, - "QTime":19}} - - * This calls the Solr core admin handler, "UNLOAD", and the parameters "deleteDataDir" and "deleteInstanceDir" to ensure that all data associated with core is also removed + {"responseHeader":{ + "status":0, + "QTime":19}} + ``` + + * This calls the Solr core admin handler, "UNLOAD", and the parameters "deleteDataDir" and "deleteInstanceDir" to ensure that all data associated with core is also removed * How can I change the /browse UI? - The primary templates are under example/files/conf/velocity. **In order to edit those files in place (without having to - re-create or patch a core/collection with an updated configuration)**, Solr can be started with a special system property - set to the _absolute_ path to the conf/velocity directory, like this: - - bin/solr start -Dvelocity.template.base.dir=</full/path/to>/example/files/conf/velocity/ + The primary templates are under example/files/conf/velocity. **In order to edit those files in place (without having to + re-create or patch a core/collection with an updated configuration)**, Solr can be started with a special system property + set to the _absolute_ path to the conf/velocity directory, like this: - If you want to adjust the browse templates for an existing collection, edit the core’s configuration - under server/solr/files/conf/velocity. + ``` + bin/solr start -Dvelocity.template.base.dir=</full/path/to>/example/files/conf/velocity/ + ``` + +If you want to adjust the browse templates for an existing collection, edit the core’s configuration +under server/solr/files/conf/velocity. ======= Review comment: At least on GitHub, this isn't showing as markup. (I assume this line is at the end directly about the provenance info) ########## File path: solr/example/README.md ########## @@ -1,57 +1,74 @@ -# 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. +<!-- + 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. +--> Solr example ------------ This directory contains Solr examples. Each example is contained in a separate directory. To run a specific example, do: +``` bin/solr -e <EXAMPLE> where <EXAMPLE> is one of: cloud : SolrCloud example dih : Data Import Handler (rdbms, mail, atom, tika) schemaless : Schema-less example (schema is inferred from data during indexing) techproducts : Kitchen sink example providing comprehensive examples of Solr features +``` For instance, if you want to run the Solr Data Import Handler example, do: +``` bin/solr -e dih - +``` + To see all the options available when starting Solr: +``` bin/solr start -help +``` After starting a Solr example, direct your Web browser to: +``` http://localhost:8983/solr/ +``` To add documents to the index, use bin/post, for example: +``` bin/post -c techproducts example/exampledocs/*.xml +``` (where "techproducts" is the Solr core name) For more information about this example please read... - * example/solr/README.txt - For more information about the "Solr Home" and Solr specific configuration - * https://lucene.apache.org/solr/guide/solr-tutorial.html - For a Solr tutorial - * http://wiki.apache.org/solr/SolrResources - For a list of other tutorials and introductory articles. + * example/solr/README.md Review comment: That path looks wrong; probably meant solr/example/README.md and it's a reference to the current document. Can you show as a link easily? If not; no big deal. ########## File path: solr/example/README.md ########## @@ -1,57 +1,74 @@ -# 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. +<!-- + 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. +--> Solr example ------------ This directory contains Solr examples. Each example is contained in a separate directory. To run a specific example, do: +``` bin/solr -e <EXAMPLE> where <EXAMPLE> is one of: cloud : SolrCloud example dih : Data Import Handler (rdbms, mail, atom, tika) schemaless : Schema-less example (schema is inferred from data during indexing) techproducts : Kitchen sink example providing comprehensive examples of Solr features +``` For instance, if you want to run the Solr Data Import Handler example, do: +``` bin/solr -e dih - +``` + To see all the options available when starting Solr: +``` bin/solr start -help +``` After starting a Solr example, direct your Web browser to: +``` http://localhost:8983/solr/ +``` To add documents to the index, use bin/post, for example: +``` bin/post -c techproducts example/exampledocs/*.xml +``` (where "techproducts" is the Solr core name) For more information about this example please read... - * example/solr/README.txt - For more information about the "Solr Home" and Solr specific configuration - * https://lucene.apache.org/solr/guide/solr-tutorial.html - For a Solr tutorial - * http://wiki.apache.org/solr/SolrResources - For a list of other tutorials and introductory articles. + * example/solr/README.md Review comment: This is a reference to itself and it's wrong; should be solr/example/README.md Not sure if you can easily do as a link but it's probably moot. ---------------------------------------------------------------- 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
