lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hoss...@apache.org
Subject [1/2] lucene-solr:jira/solr-10290: manual cleanup of w pages
Date Fri, 05 May 2017 18:21:47 GMT
Repository: lucene-solr
Updated Branches:
  refs/heads/jira/solr-10290 bf84e407e -> c7361afb8


manual cleanup of w pages


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/4697d96c
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/4697d96c
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/4697d96c

Branch: refs/heads/jira/solr-10290
Commit: 4697d96ca4bb0c6273865c88582907d2995c7d23
Parents: bf84e40
Author: Chris Hostetter <hossman@apache.org>
Authored: Fri May 5 10:30:46 2017 -0700
Committer: Chris Hostetter <hossman@apache.org>
Committed: Fri May 5 10:30:46 2017 -0700

----------------------------------------------------------------------
 solr/solr-ref-guide/src/v2-api.adoc                 | 16 ++++++++++------
 .../src/velocity-response-writer.adoc               |  8 +++++---
 solr/solr-ref-guide/src/velocity-search-ui.adoc     |  4 +---
 3 files changed, 16 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4697d96c/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 58052aa..40e8a22 100644
--- a/solr/solr-ref-guide/src/v2-api.adoc
+++ b/solr/solr-ref-guide/src/v2-api.adoc
@@ -2,7 +2,9 @@
 :page-shortname: v2-api
 :page-permalink: v2-api.html
 
-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`.
+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`.
 
 The old API and the v2 API differ in three principle ways:
 
@@ -24,8 +26,8 @@ Following are some v2 API URL paths and path prefixes, along with some of
the op
 |`/v2/c/__collection-name__/schema` |Schema requests.
 |`/v2/c/__collection-name__/__handler-name__` |Handler-specific requests.
 |`/v2/c/__collection-name__/shards` |Split a shard, create a shard, add a replica.
-|`/v2/c/__collection-name__/shards/____shard-name____ ` |Delete a shard, force leader election
-|`/v2/c/__collection-name__/shards/____shard-name____/____replica-name____` |Delete a replica.
+|`/v2/c/__collection-name__/shards/___shard-name___` |Delete a shard, force leader election
+|`/v2/c/__collection-name__/shards/___shard-name____/____replica-name___` |Delete a replica.
 |`/v2/cores` |Create a core.
 |`/v2/cores/__core-name__` |Reload, rename, delete, and unload a core.
 |`/v2/node` |Perform overseer operation, rejoin leader election.
@@ -128,7 +130,9 @@ Example of introspect for a POST API: `http://localhost:8983/v2/c/gettingstarted
     "/c/gettingstarted/export":["POST", "GET"],
     "/c/gettingstarted/admin/ping":["POST", "GET"],
     "/c/gettingstarted/update":["POST"]},
+
 [... more sub-paths ...]
+
 }
 ----
 
@@ -139,7 +143,7 @@ The `"commands"` section in the above example has one entry for each command
sup
 
 For the "gettingstarted" collection, set the replication factor and whether to automatically
add replicas (see above for the introspect output for the `"modify"` command used here):
 
-[source,text]
+[source,bash]
 ----
 $ curl http://localhost:8983/v2/c/gettingstarted -H 'Content-type:application/json' -d '
 { modify: { replicationFactor: "3", autoAddReplicas: false } }'
@@ -149,7 +153,7 @@ $ curl http://localhost:8983/v2/c/gettingstarted -H 'Content-type:application/js
 
 See the state of the cluster:
 
-[source,text]
+[source,bash]
 ----
 $ curl http://localhost:8983/v2/cluster
 
@@ -158,7 +162,7 @@ $ curl http://localhost:8983/v2/cluster
 
 Set a cluster property:
 
-[source,text]
+[source,bash]
 ----
 $ curl http://localhost:8983/v2/cluster -H 'Content-type: application/json' -d '
 { set-property: { name: autoAddReplicas, val: "false" } }'

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4697d96c/solr/solr-ref-guide/src/velocity-response-writer.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/velocity-response-writer.adoc b/solr/solr-ref-guide/src/velocity-response-writer.adoc
index 199c609..7e205ee 100644
--- a/solr/solr-ref-guide/src/velocity-response-writer.adoc
+++ b/solr/solr-ref-guide/src/velocity-response-writer.adoc
@@ -4,9 +4,9 @@
 
 The VelocityResponseWriter is an optional plugin available in the `contrib/velocity` directory.
It powers the /browse user interfaces when using configurations such as "basic_configs", "techproducts",
and "example/files".
 
-Its JAR and dependencies must be added (via <lib> or solr/home lib inclusion), and
must be registered in `solrconfig.xml` like this:
+Its JAR and dependencies must be added (via `<lib>` or solr/home lib inclusion), and
must be registered in `solrconfig.xml` like this:
 
-[source,java]
+[source,xml]
 ----
 <queryResponseWriter name="velocity" class="solr.VelocityResponseWriter">
   <str name="template.base.dir">${velocity.template.base.dir:}</str>
@@ -24,6 +24,8 @@ Its JAR and dependencies must be added (via <lib> or solr/home lib
inclusion), a
 
 The above example shows the optional initialization and custom tool parameters used by VelocityResponseWriter;
these are detailed in the following table. These initialization parameters are only specified
in the writer registration in solrconfig.xml, not as request-time parameters. See further
below for request-time parameters.
 
+== Configuration & Usage
+
 [[VelocityResponseWriter-VelocityResponseWriterinitializationparameters]]
 === VelocityResponseWriter initialization parameters
 
@@ -37,7 +39,7 @@ The above example shows the optional initialization and custom tool parameters
u
 |params.resource.loader.enabled a|
 The "params" resource loader allows templates to be specified in Solr request parameters.
For example:
 
-`http://localhost:8983``/solr``/gettingstarted``/select``?q=*:*``&wt=velocity``&v.template=custom``&v.template.custom=CUSTOM%3A%20%23core_name`
+`http://localhost:8983/solr/gettingstarted/select?q=\*:*&wt=velocity&v.template=custom&v.template.custom=CUSTOM%3A%20%23core_name`
 
 where `v.template=custom` says to render a template called "custom" and `v.template.custom`'s
value is the actual custom template. This is disabled by default; it'd be a niche, unusual,
use case to need this enabled.
 

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4697d96c/solr/solr-ref-guide/src/velocity-search-ui.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/velocity-search-ui.adoc b/solr/solr-ref-guide/src/velocity-search-ui.adoc
index 0b86cd5..51cf459 100644
--- a/solr/solr-ref-guide/src/velocity-search-ui.adoc
+++ b/solr/solr-ref-guide/src/velocity-search-ui.adoc
@@ -6,9 +6,7 @@ Solr includes a sample search UI based on the <<response-writers.adoc#ResponseWr
 
 When using the `sample_techproducts_configs` config set, you can access the Velocity sample
Search UI here: `http://localhost:8983/solr/techproducts/browse`
 
+.The Velocity Search UI
 image::images/velocity-search-ui/techproducts_browse.png[image,width=500]
 
-
-_The Velocity Search UI_
-
 For more information about the Velocity Response Writer, see the <<response-writers.adoc#ResponseWriters-VelocityResponseWriter,Response
Writer page>>.


Mime
View raw message