Skip to content

Commit fc277fa

Browse files
committed
Update docs
1 parent d52b968 commit fc277fa

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/development/search.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,14 @@ By default, Auto Indexing is turned off in development mode. To turn it on, chan
3737
After that, whenever a documentation successfully builds, or project gets added,
3838
the search index will update automatically.
3939

40-
4140
Architecture
4241
------------
4342
The search architecture is devided into 2 parts.
44-
One part is responsible for **indexing** the documents and projects and
45-
the other part is responsible for querying the Index to show the proper results to users.
46-
We use the `django-elasticsearch-dsl`_ package mostly to the keep the search working.
43+
44+
* One part is responsible for **indexing** the documents and projects (`documents.py`)
45+
* The other part is responsible for **querying** the Index to show the proper results to users (`faceted_search.py`)
46+
47+
We use the `django-elasticsearch-dsl`_ package for our Document abstraction.
4748
`django-elasticsearch-dsl`_ is a wrapper around `elasticsearch-dsl`_ for easy configuration
4849
with Django.
4950

@@ -72,11 +73,11 @@ and index/delete the documentation content from the `HTMLFile` instances.
7273

7374
How we index projects
7475
~~~~~~~~~~~~~~~~~~~~~
76+
7577
We also index project information in our search index so that the user can search for projects
76-
from the main site. `django-elasticsearch-dsl`_ listen `post_create` and `post_delete` signals of
78+
from the main site. We listen to the `post_create` and `post_delete` signals of
7779
`Project` model and index/delete into Elasticsearch accordingly.
7880

79-
8081
Elasticsearch Document
8182
~~~~~~~~~~~~~~~~~~~~~~
8283

@@ -88,9 +89,7 @@ As per requirements of `django-elasticsearch-dsl`_, it is stored in the
8889
`django-elasticsearch-dsl`_ listens to the `post_save` signal of `Project` model and
8990
then index/delete into Elasticsearch.
9091

91-
**PageDocument**: It is used for indexing documentation of projects. By default, the auto
92-
indexing is turned off by `ignore_signals = settings.ES_PAGE_IGNORE_SIGNALS`.
93-
`settings.ES_PAGE_IGNORE_SIGNALS` is `False` both in development and production.
92+
**PageDocument**: It is used for indexing documentation of projects.
9493
As mentioned above, our `Search` app listens to the `bulk_post_create` and `bulk_post_delete`
9594
signals and indexes/deleted documentation into Elasticsearch. The signal listeners are in
9695
the `readthedocs/search/signals.py` file. Both of the signals are dispatched

0 commit comments

Comments
 (0)