You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ho...@apache.org on 2017/05/08 23:01:22 UTC
[1/2] lucene-solr:jira/solr-10290: fix some absolute cwiki.apache.org
links,
add some TODO questions about anytihng still refering to cwiki.apache.org
Repository: lucene-solr
Updated Branches:
refs/heads/jira/solr-10290 218265778 -> 5105c9bba
fix some absolute cwiki.apache.org links, add some TODO questions about anytihng still refering to cwiki.apache.org
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/5105c9bb
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/5105c9bb
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/5105c9bb
Branch: refs/heads/jira/solr-10290
Commit: 5105c9bba5d00e79cea9ecd712409f4f05d86356
Parents: df8c259
Author: Chris Hostetter <ho...@apache.org>
Authored: Mon May 8 15:59:04 2017 -0700
Committer: Chris Hostetter <ho...@apache.org>
Committed: Mon May 8 15:59:49 2017 -0700
----------------------------------------------------------------------
solr/solr-ref-guide/src/common-query-parameters.adoc | 2 +-
solr/solr-ref-guide/src/defining-fields.adoc | 4 ++--
solr/solr-ref-guide/src/files-screen.adoc | 2 +-
solr/solr-ref-guide/src/making-and-restoring-backups.adoc | 2 +-
solr/solr-ref-guide/src/morelikethis.adoc | 2 +-
.../src/transforming-and-indexing-custom-json.adoc | 4 ++--
solr/solr-ref-guide/src/v2-api.adoc | 6 ++++++
7 files changed, 14 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/5105c9bb/solr/solr-ref-guide/src/common-query-parameters.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/common-query-parameters.adoc b/solr/solr-ref-guide/src/common-query-parameters.adoc
index 2ec3e7d..248d540 100644
--- a/solr/solr-ref-guide/src/common-query-parameters.adoc
+++ b/solr/solr-ref-guide/src/common-query-parameters.adoc
@@ -4,7 +4,7 @@
Several query parsers share supported query parameters.
-The table below summarizes Solr's common query parameters, which are supported by the https://cwiki.apache.org/confluence/display/solr/RequestHandlers+and+SearchComponents+in+SolrConfig#RequestHandlersandSearchComponentsinSolrConfig-SearchHandlers[Search RequestHandlers]
+The table below summarizes Solr's common query parameters, which are supported by the <<requesthandlers-and-searchcomponents-in-solrconfig#RequestHandlersandSearchComponentsinSolrConfig-SearchHandlers,Search RequestHandlers>>
// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/5105c9bb/solr/solr-ref-guide/src/defining-fields.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/defining-fields.adoc b/solr/solr-ref-guide/src/defining-fields.adoc
index 742be64..7641d96 100644
--- a/solr/solr-ref-guide/src/defining-fields.adoc
+++ b/solr/solr-ref-guide/src/defining-fields.adoc
@@ -39,7 +39,7 @@ Fields can have many of the same properties as field types. Properties from the
|Property |Description |Values |Implicit Default
|indexed |If true, the value of the field can be used in queries to retrieve matching documents. |true or false |true
|stored |If true, the actual value of the field can be retrieved by queries. |true or false |true
-|docValues |If true, the value of the field will be put in a column-oriented https://cwiki.apache.org/confluence/display/solr/DocValues[DocValues] structure. |true or false |false
+|docValues |If true, the value of the field will be put in a column-oriented <<docvalues.adoc#DocValues,DocValues>> structure. |true or false |false
|sortMissingFirst sortMissingLast |Control the placement of documents when a sort field is not present. |true or false |false
|multiValued |If true, indicates that a single document might contain multiple values for this field type. |true or false |false
|omitNorms |If true, omits the norms associated with this field (this disables length normalization for the field, and saves some memory). *Defaults to true for all primitive (non-analyzed) field types, such as int, float, data, bool, and string.* Only full-text fields or fields need norms. |true or false |*
@@ -47,6 +47,6 @@ Fields can have many of the same properties as field types. Properties from the
|omitPositions |Similar to `omitTermFreqAndPositions` but preserves term frequency information. |true or false |*
|termVectors termPositions termOffsets termPayloads |These options instruct Solr to maintain full term vectors for each document, optionally including position, offset and payload information for each term occurrence in those vectors. These can be used to accelerate highlighting and other ancillary functionality, but impose a substantial cost in terms of index size. They are not necessary for typical uses of Solr. |true or false |false
|required |Instructs Solr to reject any attempts to add a document which does not have a value for this field. This property defaults to false. |true or false |false
-|useDocValuesAsStored |If the field has https://cwiki.apache.org/confluence/display/solr/DocValues[docValues] enabled, setting this to true would allow the field to be returned as if it were a stored field (even if it has `stored=false`) when matching "`*`" in an <<common-query+parameters.adoc#CommonQueryParameters-Thefl_FieldList_Parameter,fl parameter>>. |true or false |true
+|useDocValuesAsStored |If the field has `<<docvalues.adoc#DocValues,docValues>>` enabled, setting this to true would allow the field to be returned as if it were a stored field (even if it has `stored=false`) when matching "`*`" in an <<common-query+parameters.adoc#CommonQueryParameters-Thefl_FieldList_Parameter,fl parameter>>. |true or false |true
|large |Large fields are always lazy loaded and will only take up space in the document cache if the actual value is < 512KB. This option requires `stored="true"` and `multiValued="false"`. It's intended for fields that might have very large values so that they don't get cached in memory. |true or false |false
|===
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/5105c9bb/solr/solr-ref-guide/src/files-screen.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/files-screen.adoc b/solr/solr-ref-guide/src/files-screen.adoc
index b160276..4d134e6 100644
--- a/solr/solr-ref-guide/src/files-screen.adoc
+++ b/solr/solr-ref-guide/src/files-screen.adoc
@@ -20,4 +20,4 @@ Many of the options defined in these configuration files are described throughou
* <<indexing-and-basic-data-operations.adoc#indexing-and-basic-data-operations,Indexing and Basic Data Operations>>
* <<searching.adoc#searching,Searching>>
* <<the-well-configured-solr-instance.adoc#the-well-configured-solr-instance,The Well-Configured Solr Instance>>
-* https://cwiki.apache.org/confluence/display/solr/Documents%2C+Fields%2C+and+Schema+Design[Documents, Fields, and Schema Design]
+* <<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,Documents, Fields, and Schema Design>>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/5105c9bb/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
index 75446ee..74f2973 100644
--- a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
+++ b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
@@ -199,7 +199,7 @@ The repository interfaces needs to be configured in the solr.xml file . While ru
If no repository is configured then the local filesystem repository will be used automatically.
-Example solr.xml section to configure a repository like https://cwiki.apache.org/confluence/display/solr/Running+Solr+on+HDFS[HDFS]:
+Example solr.xml section to configure a repository like <<running-solr-on-hdfs.adoc#running-solr-on-hdfs,HDFS>>:
[source,xml]
----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/5105c9bb/solr/solr-ref-guide/src/morelikethis.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/morelikethis.adoc b/solr/solr-ref-guide/src/morelikethis.adoc
index 13fee0a..a99cc03 100644
--- a/solr/solr-ref-guide/src/morelikethis.adoc
+++ b/solr/solr-ref-guide/src/morelikethis.adoc
@@ -45,7 +45,7 @@ The table below summarizes the `MoreLikeThis` parameters supported by Lucene/Sol
|mlt.maxqt |Sets the maximum number of query terms that will be included in any generated query.
|mlt.maxntp |Sets the maximum number of tokens to parse in each example document field that is not stored with TermVector support.
|mlt.boost |Specifies if the query will be boosted by the interesting term relevance. It can be either "true" or "false".
-|mlt.qf |Query fields and their boosts using the same format as that used by the https://cwiki.apache.org/confluence/display/solr/The+DisMax+Query+Parser#TheDisMaxQueryParser-Theqf(QueryFields)Parameter[DisMax Query Parser]. These fields must also be specified in `mlt.fl`.
+|mlt.qf |Query fields and their boosts using the same format as that used by the <<the-dismax-query-parser.adoc#the-dismax-query-parser,DisMax Query Parser>>. These fields must also be specified in `mlt.fl`.
|===
[[MoreLikeThis-ParametersfortheMoreLikeThisComponent]]
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/5105c9bb/solr/solr-ref-guide/src/transforming-and-indexing-custom-json.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/transforming-and-indexing-custom-json.adoc b/solr/solr-ref-guide/src/transforming-and-indexing-custom-json.adoc
index 81e4178..ce66d10 100644
--- a/solr/solr-ref-guide/src/transforming-and-indexing-custom-json.adoc
+++ b/solr/solr-ref-guide/src/transforming-and-indexing-custom-json.adoc
@@ -9,8 +9,8 @@ If you have JSON documents that you would like to index without transforming the
These parameters allow you to define how a JSON file should be read for multiple Solr documents.
-* **split**: Defines the path at which to split the input JSON into multiple Solr documents and is required if you have multiple documents in a single JSON file. If the entire JSON makes a single solr document, the path must be “`/`”. It is possible to pass multiple split paths by separating them with a pipe `(|)` example : `split=/|/foo|/foo/bar` . If one path is a child of another, they automatically become a child document **f**: This is a multivalued mapping parameter. The format of the parameter is` target-field-name:json-path`. The `json-path` is required. The `target-field-name` is the Solr document field name, and is optional. If not specified, it is automatically derived from the input JSON.The default target field name is the fully qualified name of the field. Wildcards can be used here, see the section https://cwiki.apache.org/confluence/display/solr/Uploading+Data+with+Index+Handlers#UploadingDatawithIndexHandlers-Wildcards[Wildcards] below for more information.
-* *mapUniqueKeyOnly* (boolean): This parameter is particularly convenient when the fields in the input JSON are not available in the schema and https://cwiki.apache.org/confluence/display/solr/Schemaless+Mode[schemaless mode] is not enabled. This will index all the fields into the default search field (using the `df` parameter, below) and only the `uniqueKey` field is mapped to the corresponding field in the schema. If the input JSON does not have a value for the `uniqueKey` field then a UUID is generated for the same.
+* **split**: Defines the path at which to split the input JSON into multiple Solr documents and is required if you have multiple documents in a single JSON file. If the entire JSON makes a single solr document, the path must be “`/`”. It is possible to pass multiple split paths by separating them with a pipe `(|)` example : `split=/|/foo|/foo/bar` . If one path is a child of another, they automatically become a child document **f**: This is a multivalued mapping parameter. The format of the parameter is` target-field-name:json-path`. The `json-path` is required. The `target-field-name` is the Solr document field name, and is optional. If not specified, it is automatically derived from the input JSON.The default target field name is the fully qualified name of the field. Wildcards can be used here, see the <<TransformingandIndexingCustomJSON-Wildcards,Wildcards>> below for more information.
+* *mapUniqueKeyOnly* (boolean): This parameter is particularly convenient when the fields in the input JSON are not available in the schema and <<schemaless-mode.adoc#schemaless-mode,schemaless mode>> is not enabled. This will index all the fields into the default search field (using the `df` parameter, below) and only the `uniqueKey` field is mapped to the corresponding field in the schema. If the input JSON does not have a value for the `uniqueKey` field then a UUID is generated for the same.
* **df**: If the `mapUniqueKeyOnly` flag is used, the update handler needs a field where the data should be indexed to. This is the same field that other handlers use as a default search field.
* **srcField**: This is the name of the field to which the JSON source will be stored into. This can only be used if `split=/` (i.e., you want your JSON input file to be indexed as a single Solr document). Note that atomic updates will cause the field to be out-of-sync with the document.
* **echo**: This is for debugging purpose only. Set it to true if you want the docs to be returned as a response. Nothing will be indexed.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/5105c9bb/solr/solr-ref-guide/src/v2-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/v2-api.adoc b/solr/solr-ref-guide/src/v2-api.adoc
index 603523c..782b00a 100644
--- a/solr/solr-ref-guide/src/v2-api.adoc
+++ b/solr/solr-ref-guide/src/v2-api.adoc
@@ -2,6 +2,12 @@
:page-shortname: v2-api
:page-permalink: v2-api.html
+// TODO: most of the sample introspection calls below include cwiki.apache.org URLs that should be replaced...
+// TODO: ...but they come directly from the API.
+// TODO: so first the core/src/resources/apispec/*.json files need updated, then update the docs to match
+// TODO: What URLs shold the apispec files even point to? version specific or something general?
+
+
The v2 API is a modernized self-documenting API interface covering most current Solr APIs. It is anticipated that once the v2 API reaches full coverage, and Solr-internal API usages like SolrJ and the Admin UI have been converted from the old API to the v2 API, the old API will eventually be retired.
For now the two API styles will coexist, and all the old APIs will continue to work without any change. You can disable all v2 API endpoints by starting your servers with this system property: `-Ddisable.v2.api=true`.
[2/2] lucene-solr:jira/solr-10290: update TODO with some thoughts on
the errata URLs
Posted by ho...@apache.org.
update TODO with some thoughts on the errata URLs
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/df8c2597
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/df8c2597
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/df8c2597
Branch: refs/heads/jira/solr-10290
Commit: df8c2597599756c5d572685cb5fbed9622748d07
Parents: 2182657
Author: Chris Hostetter <ho...@apache.org>
Authored: Mon May 8 14:54:00 2017 -0700
Committer: Chris Hostetter <ho...@apache.org>
Committed: Mon May 8 15:59:49 2017 -0700
----------------------------------------------------------------------
solr/solr-ref-guide/src/errata.adoc | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/df8c2597/solr/solr-ref-guide/src/errata.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/errata.adoc b/solr/solr-ref-guide/src/errata.adoc
index c3398b0..b3390fe 100644
--- a/solr/solr-ref-guide/src/errata.adoc
+++ b/solr/solr-ref-guide/src/errata.adoc
@@ -7,8 +7,16 @@
Any mistakes found in this documentation after its release will be listed on the on-line version of this page:
-//TODO we need to update this URL or make a decision about this page
-http://s.apache.org/errata[https://cwiki.apache.org/confluence/display/solr/Errata]
+//TODO we need to update this URL or make a decision about this page...
+// since we'll have the ability to regen the "hosted" HTML version of the guide,
+// after release, we can always use the verion variable to generate the Errata URL
+// specific to this "version" of the guide...
+// https://lucene.apache.org/solr/guide/{solr-docs-version}/errata.html
+// ...and/or a URL to the "latest" nightly build of the guide...
+// https://lucene.apache.org/solr/guide/nightly-draft/errata.html
+// (assuming some URL RewriteRule that maps /solr/guide/nightly/.* to our jenkins build)
+//
+http://s.apache.org/errata[http://s.apache.org/errata]
[[Errata-ErrataForPastVersionsofThisDocumentation]]
== Errata For Past Versions of This Documentation