plone / documentation

Plone Documentation

https://docs.plone.org

91 stars 153 forks source link

Mention collective.solr docs in Backend > Search, or maybe Deployment? #281

Open svx opened 9 years ago

svx commented 9 years ago

The rewrote of the docs of collective.solr is done, during PLOG 2015 was decided to include them, into docs.plone.org from docs for Plone 5 on.

Todo:

find the right place to put them
add to current papyrus
add to new test papyrus written by @jensens and test how that works

svx commented 9 years ago

First this need to be fixed:

https://github.com/collective/collective.solr/issues/67

svx commented 9 years ago

create entry pages for different use cases:

user who has already a site running and wants to include solr
use who is beginning form ' scratch'

add, update and rearrange docs for setup and installation for both use cases

tisto commented 9 years ago

I don't think it makes a lot of sense to separate those use cases since they are pretty similar (add c.solr, install c.solr, reindex). The only difference when adding c.solr to an existing site is that reindex takes longer. Even if c.solr is installed on a vanilla Plone site, you need to run reindex to include the default content.

svx commented 9 years ago

I guess we are talking about different things or I am not clear enough in what I try to say.

The docs are not that clear bout that at the moment, if you look at the docs as a Integrator they are a bit confusing if you 'just' want to add c.s to your already running site.

We did a test last week with 5 different Plone Integrators, and all of them had a hard time to understand the docs.

Do not get me wrong the docs are awesome and it a great start, but at the moment they are more for devs and not for Integrators. :)

Lets talk about that later ! :)

gforcada commented 8 years ago

What's the status here? I would like to read html rather than rst :)

svx commented 8 years ago

It is still open ? :)

The docs structure and the rst needs cleanup and the docs need review there are confusing in some parts at least for interrogators :)

stevepiercy commented 2 weeks ago

collective.solr has its own docs hosted on RTD. We don't need to pull them in, but a mention in the Plone 6 docs would be sufficient.

[ ] Add a link and brief description copied from its README in Backend > Search as an alternate search tool, or perhaps Deployment, to both:
- https://collectivesolr.readthedocs.io/en/latest/
- https://github.com/collective/collective.solr

@jensens @gforcada @sneridagh @davisagli @tisto @MrTango can you give me some context for where this mention would be belong?