Attachment 68092 Details for Bug 19462 – Bug 19462: Add koha-elasticsearch documentation

[patch] Bug 19462: Add koha-elasticsearch documentation

Bug-19462-Add-koha-elasticsearch-documentation.patch (text/plain), 4.48 KB, created by Tomás Cohen Arazi (tcohen) on 2017-10-13 18:17:51 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Tomás Cohen Arazi (tcohen)

Created: 2017-10-13 18:17:51 UTC

Size: 4.48 KB

patch

obsolete

>From 58c07ca73e4bb01d6aad01759ee36c12807823ce Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Fri, 13 Oct 2017 15:16:59 -0300
>Subject: [PATCH] Bug 19462: Add koha-elasticsearch documentation
>
>Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
>---
> debian/docs/koha-common.xml        |  12 +++++
> debian/docs/koha-elasticsearch.xml | 100 +++++++++++++++++++++++++++++++++++++
> 2 files changed, 112 insertions(+)
> create mode 100644 debian/docs/koha-elasticsearch.xml
>
>diff --git a/debian/docs/koha-common.xml b/debian/docs/koha-common.xml
>index 2790341d64..f14f750b1a 100644
>--- a/debian/docs/koha-common.xml
>+++ b/debian/docs/koha-common.xml
>@@ -155,6 +155,18 @@
>     </variablelist>
>     </refsect2>
> 
>+    <refsect2>
>+      <title>Elasticsearch-related</title>
>+        <variablelist>
>+          <varlistentry>
>+            <term><option>koha-elasticsearch</option></term>
>+            <listitem>
>+              <para>Manage Elasticsearch-related tasks for Koha instances.</para>
>+            </listitem>
>+          </varlistentry>
>+        </variablelist>
>+    </refsect2>
>+
>     <refsect2><title>E-mail</title>
>     <variablelist>
> 
>diff --git a/debian/docs/koha-elasticsearch.xml b/debian/docs/koha-elasticsearch.xml
>new file mode 100644
>index 0000000000..3dd08b0d19
>--- /dev/null
>+++ b/debian/docs/koha-elasticsearch.xml
>@@ -0,0 +1,100 @@
>+<article xmlns='http://docbook.org/ns/docbook'>
>+<title>koha-elasticsearch</title>
>+<info>
>+<productname>Koha</productname> is the first free software library automation package.
>+<author>
>+  <orgname>The Koha Community</orgname>
>+  <uri>http://koha-community.org/</uri>
>+</author>
>+</info>
>+
>+<refentry xml:id="koha-elasticsearch">
>+
>+  <refmeta>
>+    <refentrytitle>koha-elasticsearch</refentrytitle>
>+    <manvolnum>8</manvolnum>
>+  </refmeta>
>+
>+  <refnamediv>
>+    <refname>koha-elasticsearch</refname>
>+    <refpurpose>Manage Elasticsearch-related tasks for Koha instances.</refpurpose>
>+    <refclass>UNIX/Linux</refclass>
>+  </refnamediv>
>+
>+  <refsect1><title>Description</title>
>+  <para>Provides Elasticsearch-related tasks for Koha instances. An action needs to
>+        be passed.</para>
>+  </refsect1>
>+  
>+
>+  <refsynopsisdiv>
>+    <cmdsynopsis>
>+      <command>koha-elasticsearch --rebuild</command>
>+      <arg>-b|--biblios</arg>
>+      <arg>-a|--authorities</arg>
>+      <arg>-v|--verbose</arg>
>+      <arg>-c n|--commit n</arg>
>+      <arg>-v|--verbose</arg>
>+      <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
>+    </cmdsynopsis>
>+  </refsynopsisdiv>
>+  
>+  <refsect1><title>Actions</title>
>+  <variablelist> 
>+    <varlistentry>
>+      <term><option>--rebuild</option></term>
>+      <listitem>
>+        <para>Makes <refname>koha-elasticsearch</refname> rebuild Elasticsearch indexes based on the parameters.
>+              By default it rebuilds both authority and bibliographic records. This behaviour can be controlled
>+              with the <option>-a</option> and <option>-b</option> parameters.
>+        </para>
>+      </listitem>
>+    </varlistentry>
>+  </variablelist>
>+  </refsect1>
>+
>+  <refsect1><title>Options</title>
>+  <variablelist> 
>+    <varlistentry>
>+      <term><option>-a</option></term>
>+      <listitem>
>+        <para>In conjunction with <option>--rebuild</option>, it triggers authority record reindexing.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>-b</option></term>
>+      <listitem>
>+        <para>In conjunction with <option>--rebuild</option> it triggers bibliographic record reindexing.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>-c, --commit</option></term>
>+      <listitem>
>+        <para>Specifies how many records will be batched up before they are added to Elasticsearch (default: 5000).
>+              Higher values lead to better performance, but take more RAM.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>-v, --verbose</option></term>
>+      <listitem>
>+        <para>Be verbose. Useful for debugging indexing problems.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>-h, --help</option></term>
>+      <listitem>
>+        <para>Display usage information.</para>
>+      </listitem>
>+    </varlistentry>
>+  </variablelist>
>+  </refsect1>
>+
>+  <refsect1><title>See also</title>
>+  <simplelist type="inline">
>+    <member><command>koha-rebuild-zebra(8)</command></member>
>+  </simplelist>
>+  </refsect1>
>+  
>+</refentry>
>+
>+</article>
>-- 
>2.14.2

Actions: View | Diff | Splinter Review

Attachments on bug 19462: 68091 | 68092 | 68118 | 68119 | 68617 | 68618