pyes
pyes copied to clipboard
aparo
Remove "ES Reference" from docs
I understand the reasoning behind including the Elasticsearch documentation inside the Pyes documentation, but I think there's one big problem with it: It makes searching harder. Say I'm looking for the documentation of TextQuery, and try to search for that in the docs:
https://readthedocs.org/search/project/?q=TextQuery&selected_facets=project_exact%3Apyes
As you see I get all kinds of Elasticsearch hits, when I'm really interested in the parameters of the pyes specific stuff.
Could I suggest the ES docs are removed, and a link to the docs added instead? http://www.elasticsearch.org/guide/
+1 for that. A link to the official documentation would be much better.
It's very useful to have a copy of ElasticSearch guide in pyes. The sphinx documentation can be rendered as pdf and epub; so it's very useful to be packed and bring on phones and *pads. The guide also changed format lately, so when the ES site change, we need to remap all the links. I'll investigate how to remove some pages from sphinx search.
@aparo The usefulness of the extra docs is exactly what we don't agree with. It makes all your searches fill up with things you don't want. I understand your argument with having complete reference docs to bring offline, but my guess is that VERY few people use that possibility. Everyone searches the docs though.
About the recent site revamp: I don't think we need 100's of crosslinks in the docs either, just one link to the docs front page, and let people find their way there.
I must say, I personally find the presence of the ES docs within pyes extremely annoying. I often want to search the docs for how pyes deals with some ES item; and the search results are always polluted with hits from the ES docs themselves. When I search the pyes docs, I want to find out how pyes does something.
Likewise, it makes it almost impossible to google something pyes-related - search results always include lots of stock ES docs.
Happy to submit a PR to remove.
