New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix #4268] Adding Documentation for upgraded Search #4467

Merged
merged 8 commits into from Sep 7, 2018

Conversation

4 participants
@safwanrahman
Member

safwanrahman commented Aug 3, 2018

I have added instruction for preparing the local development for search. Its first step towards documentation of search as proposed in #4268.
@ericholscher r?

@safwanrahman safwanrahman requested a review from ericholscher Aug 3, 2018

@ericholscher

A good start. Needs some spell checking, and I think I touched on the grammar issues I found.

Show outdated Hide outdated docs/development/search.rst
Show outdated Hide outdated docs/development/search.rst
Show outdated Hide outdated docs/development/search.rst

@safwanrahman safwanrahman changed the title from Adding Documentation for upgraded Search to [Fix #4268] Adding Documentation for upgraded Search Aug 7, 2018

@safwanrahman

This comment has been minimized.

Show comment
Hide comment
@safwanrahman

safwanrahman Aug 7, 2018

Member

@ericholscher fixed the grammer and added some docs about architecture. Is it ready to merge?

Member

safwanrahman commented Aug 7, 2018

@ericholscher fixed the grammer and added some docs about architecture. Is it ready to merge?

@RichardLitt

This comment has been minimized.

Show comment
Hide comment
@RichardLitt

RichardLitt Aug 7, 2018

Member

Whoa, sorry. Got carried away with some small changes. :) Let me know if you want help.

Member

RichardLitt commented Aug 7, 2018

Whoa, sorry. Got carried away with some small changes. :) Let me know if you want help.

@safwanrahman

This comment has been minimized.

Show comment
Hide comment
@safwanrahman

safwanrahman Aug 8, 2018

Member

@RichardLitt I have fixed all the issue you have mentioned. can you check again?

Member

safwanrahman commented Aug 8, 2018

@RichardLitt I have fixed all the issue you have mentioned. can you check again?

@RichardLitt

Getting there! Sorry about all of these comments.

@safwanrahman

This comment has been minimized.

Show comment
Hide comment
@safwanrahman

safwanrahman Aug 10, 2018

Member

@RichardLitt I have updated the issues you have mentioned.

Member

safwanrahman commented Aug 10, 2018

@RichardLitt I have updated the issues you have mentioned.

@ericholscher

This looks great. We could definitely add a bit more detail in some places, but I think this is a solid start to work from. 👍

For using search, you need to index data to the Elasticsearch Index. Run `reindex_elasticsearch`
management command::
./manage.py reindex_elasticsearch

This comment has been minimized.

@ericholscher

ericholscher Aug 10, 2018

Member

It's probably worth noting here why we implemented our own version, instead of using the detail one provided by django-elasticsearch-dsl.

@ericholscher

ericholscher Aug 10, 2018

Member

It's probably worth noting here why we implemented our own version, instead of using the detail one provided by django-elasticsearch-dsl.

Show outdated Hide outdated docs/development/search.rst
Show outdated Hide outdated docs/development/search.rst
@RichardLitt

This comment has been minimized.

Show comment
Hide comment
@RichardLitt

RichardLitt Aug 10, 2018

Member

@safwanrahman Thanks. :) Sorry for being so persnickety!

Member

RichardLitt commented Aug 10, 2018

@safwanrahman Thanks. :) Sorry for being so persnickety!

@safwanrahman

This comment has been minimized.

Show comment
Hide comment
@safwanrahman

safwanrahman Aug 10, 2018

Member

@ericholscher updated with fixes. Possible to merge?

Member

safwanrahman commented Aug 10, 2018

@ericholscher updated with fixes. Possible to merge?

@safwanrahman safwanrahman added this to Backlog in Search update via automation Aug 11, 2018

@safwanrahman safwanrahman moved this from Backlog to In progress in Search update Aug 11, 2018

@agjohnson agjohnson added this to the Search improvements milestone Aug 27, 2018

@ericholscher ericholscher merged commit 88ff413 into rtfd:search_upgrade Sep 7, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

Search update automation moved this from In progress to Done Sep 7, 2018

safwanrahman added a commit to safwanrahman/readthedocs.org that referenced this pull request Sep 15, 2018

Merge pull request rtfd#4467 from safwanrahman/search_docs
[Fix rtfd#4268] Adding Documentation for upgraded Search
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment