From 928be7065e4201ca43e069754e0d421fd535b980 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Thu, 15 Dec 2016 21:37:47 -0800 Subject: [PATCH 1/2] Installation docs: Mention ElasticSearch Add an optional ElasticSearch installation step in the documentation. Closes https://github.com/python/pythondotorg/issues/1033 --- docs/source/install.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/install.rst b/docs/source/install.rst index ab50a2efd..3fcb05dec 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -181,3 +181,15 @@ To build this documentation locally:: If you don't want to open the browser automatically, you can do:: $ make -C docs/ html + + +Optional: Install ElasticSearch +------------------------------- + +The search feature in Python.org uses ElasticSearch engine. If you want to +test out this feature, you will need to install ElasticSearch_. + +Once you have it installed, update the URL value of ``HAYSTACK_CONNECTIONS`` +settings in ``pydotorg/settings/local.py`` to your local ElasticSearch server. + +.. _ElasticSearch: https://www.elastic.co/downloads/elasticsearch From 339940a190674f5e1bc86be47bfd1846ed244f65 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Thu, 15 Dec 2016 21:54:24 -0800 Subject: [PATCH 2/2] move elasticsearch section --- docs/source/install.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/source/install.rst b/docs/source/install.rst index 3fcb05dec..82d4357cc 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -99,6 +99,18 @@ Finally, start the development server:: $ ./manage.py runserver +Optional: Install Elasticsearch +------------------------------- + +The search feature in Python.org uses Elasticsearch engine. If you want to +test out this feature, you will need to install Elasticsearch_. + +Once you have it installed, update the URL value of ``HAYSTACK_CONNECTIONS`` +settings in ``pydotorg/settings/local.py`` to your local ElasticSearch server. + +.. _Elasticsearch: https://www.elastic.co/downloads/elasticsearch + + Generating CSS files automatically ---------------------------------- @@ -181,15 +193,3 @@ To build this documentation locally:: If you don't want to open the browser automatically, you can do:: $ make -C docs/ html - - -Optional: Install ElasticSearch -------------------------------- - -The search feature in Python.org uses ElasticSearch engine. If you want to -test out this feature, you will need to install ElasticSearch_. - -Once you have it installed, update the URL value of ``HAYSTACK_CONNECTIONS`` -settings in ``pydotorg/settings/local.py`` to your local ElasticSearch server. - -.. _ElasticSearch: https://www.elastic.co/downloads/elasticsearch