search

django-haystack / pysolr

Pysolr — Python Solr client
BSD 3-Clause "New" or "Revised" License
665 stars 339 forks source link

Documentation is...lacking. #202

Closed mlissner closed 6 years ago

mlissner commented 8 years ago

I'm curious if there is an appetite for better documentation. I'm just trying out PySolr, and I can't find anything beyond the readme.

I have:

As a first pass, it seems worthwhile to simply expand the readme so that it has more details. Long term, I guess we'll want something more official, like a page on readthedocs or something, but there's value in keeping the infrastructure simple, at least at first.

A few things I've already run into just in my own exploration:

These are things I'll be figuring out, but I'd love if there was more detailed documentation of all this, as well as a process for updating the documentation if a PR adds a new feature.

Any appetite? If so, any way to ping the group and seek input as to what else should go into this kind of a guide? I can probably send a PR to the readme with a number of these things if this is something we're interested in.

acdha commented 8 years ago

We definitely could use some documentation improvements. It's probably time to reconsider migrating everything to Sphinx so we could have pysolr.readthedocs.org work as it does for Haystack, especially since some of the newer work on e.g. SolrCloud / ZooKeeper opens up a considerable amount of complexity.

XciA commented 7 years ago

At least a few examples could have helped.Why there is no documentation?

acdha commented 7 years ago

@XciA There is documentation: https://github.com/django-haystack/pysolr#usage

Is it complete? Of course not, but everyone knows that — it's always been a question of people having time to improve things. If you have specific improvements in mind, please open a pull request with your proposed changes.

stale[bot] commented 6 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.