Apache Solr open-source search software
SOLR-15926: Fix git links and versions in the ref guide (#548)
Houston Putman17ea1bd2d591
diff --git a/solr/solr-ref-guide/src/basic-authentication-plugin.adoc b/solr/solr-ref-guide/src/basic-authentication-plugin.adocindex 1674c2aebcc..7f5baba5154 100644--- a/solr/solr-ref-guide/src/basic-authentication-plugin.adoc+++ b/solr/solr-ref-guide/src/basic-authentication-plugin.adoc@@ -357,6 +357,8 @@ SOLR_AUTHENTICATION_OPTS="-Dbasicauth=solr:SolrRocks"Alternatively, the `SOLR_AUTHENTICATION_OPTS` can take a path to a file, as in:-[source,bash]+[source,bash,subs="attributes"]+----SOLR_AUTH_TYPE="basic"-SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-{solr-docs-version}.0/server/solr/basicAuth.conf"+SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-{solr-full-version}/server/solr/basicAuth.conf"+----diff --git a/solr/solr-ref-guide/src/docker-networking.adoc b/solr/solr-ref-guide/src/docker-networking.adocindex 68a6931c160..6c2acf88520 100644--- a/solr/solr-ref-guide/src/docker-networking.adoc+++ b/solr/solr-ref-guide/src/docker-networking.adoc@@ -202,11 +202,11 @@ ssh -n $ZKSOLR1_HOST docker exec -i zksolr1 /opt/solr/bin/solr create_collectionTo load data, and see it was split over shards:-[source,bash]+[source,bash,subs="attributes"]----docker exec -it --user=solr zksolr1 bin/post -c my_collection1 example/exampledocs/manufacturers.xml# /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java -classpath /opt/solr/server/lib/ext/*:/opt/solr/server/solr-webapp/webapp/WEB-INF/lib/* -Dauto=yes -Dc=my_collection1 -Ddata=files org.apache.solr.util.SimplePostTool example/exampledocs/manufacturers.xml-# SimplePostTool version 9.0.0+# SimplePostTool version {solr-full-version}# Posting files to [base] url http://localhost:8983/solr/my_collection1/update...# Entering auto mode. File endings considered are xml,json,csv,pdf,doc,docx,ppt,pptx,xls,xlsx,odt,odp,ods,ott,otp,ots,rtf,htm,html,txt,log# POSTing file manufacturers.xml (application/xml) to [base]diff --git a/solr/solr-ref-guide/src/installing-solr.adoc b/solr/solr-ref-guide/src/installing-solr.adocindex 9082308deb9..0493a854256 100644--- a/solr/solr-ref-guide/src/installing-solr.adoc+++ b/solr/solr-ref-guide/src/installing-solr.adoc@@ -62,7 +62,7 @@ To keep things simple for now, extract the Solr distribution archive to your loc[source,bash,subs="attributes"]----cd ~/-tar zxf solr-{solr-docs-version}.0.tgz+tar zxf solr-{solr-full-version}.tgz----Once extracted, you are now ready to run Solr using the instructions provided in the <<Starting Solr>> section below.diff --git a/solr/solr-ref-guide/src/jdbc-zeppelin.adoc b/solr/solr-ref-guide/src/jdbc-zeppelin.adocindex 672a63e8b53..3b2e732b10d 100644--- a/solr/solr-ref-guide/src/jdbc-zeppelin.adoc+++ b/solr/solr-ref-guide/src/jdbc-zeppelin.adoc@@ -67,7 +67,7 @@ Interpreter : jdbcdefault.url : jdbc:solr://SOLR_ZK_CONNECTION_STRING?collection=<collection_name>default.driver : org.apache.solr.client.solrj.io.sql.DriverImpldefault.user : solr-dependency : org.apache.solr:solr-solrj:{solr-docs-version}.0+dependency : org.apache.solr:solr-solrj:{solr-full-version}----== Query with the Notebookdiff --git a/solr/solr-ref-guide/src/learning-to-rank.adoc b/solr/solr-ref-guide/src/learning-to-rank.adocindex 414bbe61b0f..8d442fa9135 100644--- a/solr/solr-ref-guide/src/learning-to-rank.adoc+++ b/solr/solr-ref-guide/src/learning-to-rank.adoc@@ -472,7 +472,7 @@ Read more about model evolution in the <<LTR Lifecycle>> section of this page.=== Training Example-Example training data and a demo `train_and_upload_demo_model.py` script can be found in the `solr/modules/ltr/example` folder in the https://gitbox.apache.org/repos/asf?p=lucene-solr.git;a=tree;f=solr/modules/ltr/example[Apache lucene-solr Git repository] (mirrored on https://github.com/apache/lucene-solr/tree/releases/lucene-solr/{solr-docs-version}.0/solr/modules/ltr/example[github.com]).+Example training data and a demo `train_and_upload_demo_model.py` script can be found in the `solr/modules/ltr/example` folder in the https://gitbox.apache.org/repos/asf?p=solr.git;a=tree;f=solr/modules/ltr/example[Apache lucene-solr Git repository] (mirrored on https://github.com/apache/lucene-solr/tree/releases/lucene-solr/{solr-full-version}/solr/modules/ltr/example[github.com]).This example folder is not shipped in the Solr binary release.== Installation of LTRdiff --git a/solr/solr-ref-guide/src/package-manager-internals.adoc b/solr/solr-ref-guide/src/package-manager-internals.adocindex 9c2db2253ed..20f8f94ff4a 100644--- a/solr/solr-ref-guide/src/package-manager-internals.adoc+++ b/solr/solr-ref-guide/src/package-manager-internals.adoc@@ -97,9 +97,9 @@ Use the following steps to upload a jar signed with your public key:. If you don't have a jar file with plugins, download a sample from github:+-[source, bash]+[source, bash,subs="attributes"]-----$ curl -o runtimelibs.jar -LO https://github.com/apache/lucene-solr/blob/master/solr/core/src/test-files/runtimecode/runtimelibs.jar.bin?raw=true+$ curl -o runtimelibs.jar -LO https://github.com/apache/solr/blob/releases/solr/{solr-full-version}/solr/core/src/test-files/runtimecode/runtimelibs.jar.bin?raw=true----. Sign the jar with your private key:@@ -305,9 +305,9 @@ $ curl http://localhost:8983/solr/gettingstarted/test?omitHeader=true. Update the version of our component.Get a new version of the jar, sign and upload it:+-[source, bash]+[source, bash,subs="attributes"]-----$ curl -o runtimelibs3.jar -LO https://github.com/apache/lucene-solr/blob/master/solr/core/src/test-files/runtimecode/runtimelibs_v3.jar.bin?raw=true+$ curl -o runtimelibs3.jar -LO https://github.com/apache/solr/blob/releases/solr/{solr-full-version}/solr/core/src/test-files/runtimecode/runtimelibs_v3.jar.bin?raw=true$ openssl dgst -sha1 -sign my_key.pem runtimelibs.jar | openssl enc -base64 | sed 's/+/%2B/g' | tr -d \\n | seddiff --git a/solr/solr-ref-guide/src/partial-document-updates.adoc b/solr/solr-ref-guide/src/partial-document-updates.adocindex 648fe4b4d3a..d479957133f 100644--- a/solr/solr-ref-guide/src/partial-document-updates.adoc+++ b/solr/solr-ref-guide/src/partial-document-updates.adoc@@ -542,4 +542,4 @@ If `versionField` is specified as a list, then this parameter too must be specif+If set to `true`, allows any document written *before* this feature is enabled and are missing the `versionField`, to be overwritten.-Please consult the {solr-javadocs}/core/org/apache/solr/update/processor/DocBasedVersionConstraintsProcessorFactory.html[DocBasedVersionConstraintsProcessorFactory javadocs] and https://github.com/apache/lucene-solr/blob/master/solr/core/src/test-files/solr/collection1/conf/solrconfig-externalversionconstraint.xml[test solrconfig.xml file] for additional information and example usages.+Please consult the {solr-javadocs}/core/org/apache/solr/update/processor/DocBasedVersionConstraintsProcessorFactory.html[DocBasedVersionConstraintsProcessorFactory javadocs] and https://github.com/apache/solr/blob/releases/solr/{solr-full-version}/solr/core/src/test-files/solr/collection1/conf/solrconfig-externalversionconstraint.xml[test solrconfig.xml file] for additional information and example usages.diff --git a/solr/solr-ref-guide/src/solr-control-script-reference.adoc b/solr/solr-ref-guide/src/solr-control-script-reference.adocindex 573a398ecf1..ff7864ed828 100644--- a/solr/solr-ref-guide/src/solr-control-script-reference.adoc+++ b/solr/solr-ref-guide/src/solr-control-script-reference.adoc@@ -784,7 +784,7 @@ The `security.json` file will look similar to:----# The following lines added by ./solr for enabling BasicAuthSOLR_AUTH_TYPE="basic"-SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-{solr-docs-version}.0/server/solr/basicAuth.conf"+SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-{solr-full-version}/server/solr/basicAuth.conf"----* Creates the file `server/solr/basicAuth.conf` to store the credential information that is used with `bin/solr` commands.diff --git a/solr/solr-ref-guide/src/taking-solr-to-production.adoc b/solr/solr-ref-guide/src/taking-solr-to-production.adocindex cd3c7aa6d9b..a663788c459 100644--- a/solr/solr-ref-guide/src/taking-solr-to-production.adoc+++ b/solr/solr-ref-guide/src/taking-solr-to-production.adoc@@ -35,12 +35,12 @@ We recommend separating your live Solr files, such as logs and index files, fromBy default, the service installation script will extract the distribution archive into `/opt`.You can change this location using the `-i` option when running the installation script.The script will also create a symbolic link to the versioned directory of Solr.-For instance, if you run the installation script for Solr {solr-docs-version}.0, then the following directory structure will be used:+For instance, if you run the installation script for Solr {solr-full-version}, then the following directory structure will be used:[source,plain,subs="attributes"]-----/opt/solr-{solr-docs-version}.0-/opt/solr -> /opt/solr-{solr-docs-version}.0+/opt/solr-{solr-full-version}+/opt/solr -> /opt/solr-{solr-full-version}----Using a symbolic link insulates any scripts from being dependent on the specific Solr version.@@ -68,7 +68,7 @@ To run the script, you'll need to download the latest Solr distribution archive[source,bash,subs="attributes"]-----tar xzf solr-{solr-docs-version}.0.tgz solr-{solr-docs-version}.0/bin/install_solr_service.sh --strip-components=2+tar xzf solr-{solr-full-version}.tgz solr-{solr-full-version}/bin/install_solr_service.sh --strip-components=2----The previous command extracts the `install_solr_service.sh` script from the archive into the current directory.@@ -77,7 +77,7 @@ The installation script must be run as root:[source,bash,subs="attributes"]-----sudo bash ./install_solr_service.sh solr-{solr-docs-version}.0.tgz+sudo bash ./install_solr_service.sh solr-{solr-full-version}.tgz----By default, the script extracts the distribution archive into `/opt`, configures Solr to write files into `/var/solr`, and runs Solr as the `solr` user.@@ -85,7 +85,7 @@ Consequently, the following command produces the same result as the previous com[source,bash,subs="attributes"]-----sudo bash ./install_solr_service.sh solr-{solr-docs-version}.0.tgz -i /opt -d /var/solr -u solr -s solr -p 8983+sudo bash ./install_solr_service.sh solr-{solr-full-version}.tgz -i /opt -d /var/solr -u solr -s solr -p 8983----You can customize the service name, installation directories, port, and owner using options passed to the installation script.@@ -464,7 +464,7 @@ The easiest approach is to use the service installation script to add multiple s[source,bash,subs="attributes"]-----sudo bash ./install_solr_service.sh solr-{solr-docs-version}.0.tgz -s solr2 -p 8984+sudo bash ./install_solr_service.sh solr-{solr-full-version}.tgz -s solr2 -p 8984----The command shown above will add a service named `solr2` running on port 8984 using `/var/solr2` for writable (aka "live") files; the second server will still be owned and run by the `solr` user and will use the Solr distribution files in `/opt`.diff --git a/solr/solr-ref-guide/src/tutorial-aws.adoc b/solr/solr-ref-guide/src/tutorial-aws.adocindex 337a6e9eb23..cef57dc47f5 100644--- a/solr/solr-ref-guide/src/tutorial-aws.adoc+++ b/solr/solr-ref-guide/src/tutorial-aws.adoc@@ -140,14 +140,14 @@ $ java -version+[source,bash,subs="verbatim,attributes+"]# download desired version of Solr-$ wget http://archive.apache.org/dist/lucene/solr/{solr-docs-version}.0/solr-{solr-docs-version}.0.tgz+$ wget http://archive.apache.org/dist/lucene/solr/{solr-full-version}/solr-{solr-full-version}.tgz# untar-$ tar -zxvf solr-{solr-docs-version}.0.tgz+$ tar -zxvf solr-{solr-full-version}.tgz# set SOLR_HOME-$ export SOLR_HOME=$PWD/solr-{solr-docs-version}.0+$ export SOLR_HOME=$PWD/solr-{solr-full-version}# put the env variable in .bashrc# vim ~/.bashrc-export SOLR_HOME=/home/ec2-user/solr-{solr-docs-version}.0+export SOLR_HOME=/home/ec2-user/solr-{solr-full-version}. Resolve the Public DNS to simpler hostnames.+diff --git a/solr/solr-ref-guide/src/tutorial-films.adoc b/solr/solr-ref-guide/src/tutorial-films.adocindex 617c33460e9..a1ea79df4f6 100644--- a/solr/solr-ref-guide/src/tutorial-films.adoc+++ b/solr/solr-ref-guide/src/tutorial-films.adoc@@ -88,7 +88,7 @@ WARNING: Using _default configset. Data driven schema functionality is enabled bConnecting to ZooKeeper at localhost:9983 ...INFO - 2017-07-27 15:07:46.191; org.apache.solr.client.solrj.impl.ZkClientClusterStateProvider; Cluster at localhost:9983 ready-Uploading /{solr-docs-version}.0/server/solr/configsets/_default/conf for config films to ZooKeeper at localhost:9983+Uploading /{solr-full-version}/server/solr/configsets/_default/conf for config films to ZooKeeper at localhost:9983Creating new collection 'films' using command:http://localhost:7574/solr/admin/collections?action=CREATE&name=films&numShards=2&replicationFactor=2&collection.configName=films@@ -210,7 +210,7 @@ Pick one of the formats and index it into the "films" collection (in each exampl----bin/post -c films example/films/films.json-C:\solr-{solr-docs-version}.0> java -jar -Dc=films -Dauto example\exampledocs\post.jar example\films\*.json+C:\solr-{solr-full-version}> java -jar -Dc=films -Dauto example\exampledocs\post.jar example\films\*.json----.To Index XML Format@@ -218,7 +218,7 @@ C:\solr-{solr-docs-version}.0> java -jar -Dc=films -Dauto example\exampledocs\po----bin/post -c films example/films/films.xml-C:\solr-{solr-docs-version}.0> java -jar -Dc=films -Dauto example\exampledocs\post.jar example\films\*.xml+C:\solr-{solr-full-version}> java -jar -Dc=films -Dauto example\exampledocs\post.jar example\films\*.xml----.To Index CSV Format@@ -226,7 +226,7 @@ C:\solr-{solr-docs-version}.0> java -jar -Dc=films -Dauto example\exampledocs\po----bin/post -c films example/films/films.csv -params "f.genre.split=true&f.directed_by.split=true&f.genre.separator=|&f.directed_by.separator=|"-C:\solr-{solr-docs-version}.0> java -jar -Dc=films -Dparams=f.genre.split=true&f.directed_by.split=true&f.genre.separator=|&f.directed_by.separator=| -Dauto example\exampledocs\post.jar example\films\*.csv+C:\solr-{solr-full-version}> java -jar -Dc=films -Dparams=f.genre.split=true&f.directed_by.split=true&f.genre.separator=|&f.directed_by.separator=| -Dauto example\exampledocs\post.jar example\films\*.csv----Each command includes these main parameters:@@ -244,7 +244,7 @@ Each command will produce output similar to the below seen while indexing JSON:[source,bash,subs="verbatim,attributes"]----$ ./bin/post -c films example/films/films.json-/bin/java -classpath /solr-{solr-docs-version}.0/server/solr-webapp/webapp/WEB-INF/lib/solr-core-{solr-docs-version}.0.jar -Dauto=yes -Dc=films -Ddata=files org.apache.solr.util.SimplePostTool example/films/films.json+/bin/java -classpath /solr-{solr-full-version}/server/solr-webapp/webapp/WEB-INF/lib/solr-core-{solr-full-version}.jar -Dauto=yes -Dc=films -Ddata=files org.apache.solr.util.SimplePostTool example/films/films.jsonSimplePostTool version 5.0.0Posting files to [base] url http://localhost:8983/solr/films/update...Entering auto mode. File endings considered are xml,json,jsonl,csv,pdf,doc,docx,ppt,pptx,xls,xlsx,odt,odp,ods,ott,otp,ots,rtf,htm,html,txt,logdiff --git a/solr/solr-ref-guide/src/tutorial-techproducts.adoc b/solr/solr-ref-guide/src/tutorial-techproducts.adocindex 97fe3c940fd..6169f40bfb8 100644--- a/solr/solr-ref-guide/src/tutorial-techproducts.adoc+++ b/solr/solr-ref-guide/src/tutorial-techproducts.adoc@@ -28,7 +28,7 @@ This command has an option to run without prompting you for input (`-noprompt`),[source,subs="verbatim,attributes+"]-----solr-{solr-docs-version}.0:$ ./bin/solr start -e cloud+solr-{solr-full-version}:$ ./bin/solr start -e cloudWelcome to the SolrCloud example!@@ -63,9 +63,9 @@ The script will print the commands it uses for your reference.----Starting up 2 Solr nodes for your example SolrCloud cluster.-Creating Solr home directory /solr-{solr-docs-version}.0/example/cloud/node1/solr-Cloning /solr-{solr-docs-version}.0/example/cloud/node1 into- /solr-{solr-docs-version}.0/example/cloud/node2+Creating Solr home directory /solr-{solr-full-version}/example/cloud/node1/solr+Cloning /solr-{solr-full-version}/example/cloud/node1 into+ /solr-{solr-full-version}/example/cloud/node2Starting up Solr on port 8983 using command:"bin/solr" start -cloud -p 8983 -s "example/cloud/node1/solr"@@ -134,11 +134,11 @@ At this point, Solr will create the collection and again output to the screen th[source,subs="verbatim,attributes+"]-----Uploading /solr-{solr-docs-version}.0/server/solr/configsets/_default/conf for config techproducts to ZooKeeper at localhost:9983+Uploading /solr-{solr-full-version}/server/solr/configsets/_default/conf for config techproducts to ZooKeeper at localhost:9983Connecting to ZooKeeper at localhost:9983 ...INFO - 2017-07-27 12:48:59.289; org.apache.solr.client.solrj.impl.ZkClientClusterStateProvider; Cluster at localhost:9983 ready-Uploading /solr-{solr-docs-version}.0/server/solr/configsets/sample_techproducts_configs/conf for config techproducts to ZooKeeper at localhost:9983+Uploading /solr-{solr-full-version}/server/solr/configsets/sample_techproducts_configs/conf for config techproducts to ZooKeeper at localhost:9983Creating new collection 'techproducts' using command:http://localhost:8983/solr/admin/collections?action=CREATE&name=techproducts&numShards=2&replicationFactor=2&collection.configName=techproducts@@ -199,13 +199,13 @@ The documents are in a mix of document formats (JSON, CSV, etc.), and fortunatel.Linux/Mac[source,subs="verbatim,attributes+"]-----solr-{solr-docs-version}.0:$ bin/post -c techproducts example/exampledocs/*+solr-{solr-full-version}:$ bin/post -c techproducts example/exampledocs/*----.Windows[source,subs="verbatim,attributes+"]-----C:\solr-{solr-docs-version}.0> java -jar -Dc=techproducts -Dauto example\exampledocs\post.jar example\exampledocs\*+C:\solr-{solr-full-version}> java -jar -Dc=techproducts -Dauto example\exampledocs\post.jar example\exampledocs\*----You should see output similar to the following: