Skip to content

Commit 9014f2e

Browse files
committed
NGSTACK-836 documentation changes
1 parent 113a696 commit 9014f2e

File tree

1 file changed

+6
-15
lines changed

1 file changed

+6
-15
lines changed

docs/reference/descendant_indexing.rst

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ Descendant indexing
22
=====================
33

44
This feature helps in indexing hierarchical content structures. It allows the children of a content item to be indexed
5-
within the same document as the parent if both are configured for descendant indexing.
5+
within the same document as the parent if both are configured for descendant indexing. This means that when you search
6+
for a child content, the parent content will also appear in the search results.
67

78
''Configuration''
89

@@ -23,6 +24,8 @@ To enable this feature, set up the descendant indexing configuration:
2324
2425
The ``enabled`` field must be set to true to activate descendant indexing services by registering them in the container.
2526
In the array parameter ``map`` we define the structure of content to be included in descendant indexing by content types.
27+
The first content type identifier represents the parent content, which will hold the indexed children content document,
28+
and the rest represent the structure under it and whether it will be indexed or not.
2629
Any structure in the content tree that matches the configuration will be part of descendant indexing. Content can be
2730
part of the structure but not included in the index. To index the content in the parent document, set the ``indexed```
2831
parameter to ``true``.
@@ -55,17 +58,5 @@ identifier defined in the configuration.
5558
return 'ng_descendant_indexing_fulltext';
5659
}
5760
58-
''AncestorIndexer''
59-
60-
AncestorIndexer is a service that ensures descendant indexing is considered during reindexing. For example, if we edit
61-
content that is part of the descendant indexing map, the descendant content in which it is indexed should also be
62-
reindexed.
63-
64-
The service contains methods ``indexSingle()`` and ``indexMultiple()``, which are called in handlers for any content
65-
changes (e.g., ``CopyContentHandler``, ``DeleteContentHandler``). These methods use the AncestorResolver service to
66-
resolve the ancestor to be reindexed. If no ancestor matches the configuration map structure, the ``resolveAncestor()``
67-
method returns null.
68-
69-
The AncestorResolver service uses AncestorPathGenerator service to read from the configuration and return an array of
70-
strings representing all of the paths matching the given configuration in order to be able to find a match with any of
71-
the paths.
61+
The BaseFieldMapper is implemented only for Solr indexing engine and the field mappers are plugged into the existing
62+
solr indexing system.

0 commit comments

Comments
 (0)