From e0dccd2ff48af1d245fb13132339ba970e8a600a Mon Sep 17 00:00:00 2001 From: Andrii V Date: Thu, 19 Jun 2025 19:14:52 +0200 Subject: [PATCH] chore: fixed search index docs --- docs/.howto | 2 +- docs/admin/system_admin/indexing.rst | 19 +++++++++++-------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/.howto b/docs/.howto index 5bae66a5..4f74b8c7 100644 --- a/docs/.howto +++ b/docs/.howto @@ -3,4 +3,4 @@ # docker build --tag sphinx-doc-build-rc . # Build Docs -# cd && docker run --rm -v $(pwd):/project --workdir=/project/docs sphinx-doc-build-rc make clean html +# cd .. && docker run --rm -v $(pwd):/project --workdir=/project/docs sphinx-doc-build-rc make clean html diff --git a/docs/admin/system_admin/indexing.rst b/docs/admin/system_admin/indexing.rst index 88b29fee..42de3a1a 100644 --- a/docs/admin/system_admin/indexing.rst +++ b/docs/admin/system_admin/indexing.rst @@ -3,16 +3,19 @@ Full-text Search ---------------- +.. important:: + + Some parts of this page refers to legacy components like rccontrol + We are in process of updating documentantion with up-to-date information + + RhodeCode provides a full text search capabilities to search inside file content, -commit message, and file paths. Indexing is not enabled by default and to use -full text search building an index is a pre-requisite. +commit message, and file paths (This featureis only available in Enterprise edition). +Indexing is not enabled by default and to use full text search building an index is a pre-requisite. -By default RhodeCode is configured to use `Whoosh`_ to index |repos| and -provide full-text search. `Whoosh`_ works well for a small amount of data and -shouldn't be used in case of large code-bases and lots of repositories. +|RCE| provides support for `ElasticSearch 8`_ as a backend to index |repos|. +See :ref:`enable-elasticsearch` for details. -|RCE| also provides support for `ElasticSearch 6`_ as a backend more for advanced -and scalable search. See :ref:`enable-elasticsearch` for details. Indexing ^^^^^^^^ @@ -343,4 +346,4 @@ For example:: rhodecode-index --instance-name=enterprise-1 --es-version=8 --engine-location=http://elasticsearch:9200 -.. _ElasticSearch 6: https://www.elastic.co/ +.. _ElasticSearch 8: https://www.elastic.co/