Hoss et. al,

I'm not intending on contributing documentation in any immediate sense (the
disclaimer), but I thank you all for the clarification.

It makes some sense to require a committer to review each suggested piece
of official documentation, but I wonder abstractly how a non-committer then
should contribute to the documentation.  I just did an evaluation of
several WCM systems, and it sounds almost like you need something more like
a WCM that supports some moderation workflow, rather than a wiki.

With current technology, possibilities include:

 * Make a comment within Confluence suggesting content or making a
clarification,
 * Create a blog post or MoinMoin edit with whatever content seems to be
needed,
 * Paste text and/or content into a JIRA ticket, or upload an attachment to
the JIRA ticket.

I think the JIRA ticket is the strongest, honestly, because it is true
moderation - nothing shows up until evaluated by a committer.

I also want to say that I value the very technical nature of the Solr
documentation, even as I welcome better organization   Many product's
documentation is very much too much abstracted, because it is written by a
technical writer not deeply familiar with either the technology or with
what users specifically want to do.   This is addressed by surfacing what
the user's want to do, and then "How-to" specific documentation is written
that is still too vague on the technical details.   Sometimes a worked
example is very useful.     I see a little, though not too much, of this
transition in the Data Import Handler documentation -
https://cwiki.apache.org/confluence/display/solr/Uploading+Structured+Data+Store+Data+with+the+Data+Import+Handler
is more abstract, and moves too fast, relative to
http://wiki.apache.org/solr/DataImportHandler.   The ability to nest SQL
based entities is very key to understanding, and not covered in the former.
  One needs to see that entity is not always a root entity.

So, I agree with the direction, but I hope the Solr Reference Guide can go
into more depth in some places, even as it continues to be better organized
if you are reading from scratch rather than starting with Solr In Action or
something like that.

Thanks again,

Dan


On Mon, Feb 2, 2015 at 11:57 AM, Chris Hostetter <hossman_luc...@fucit.org>
wrote:

>
> : Because they have different potential authors, the two systems now serve
> : different purposes.
> :
> : There are still some pages on the MoinMoin wiki that contain
> : documentation that should be in the reference guide, but isn't.
> :
> : The MoinMoin wiki is still useful, as a place where users can collect
> : information that is useful to others, but doesn't qualify as official
> : documentation, or perhaps simply hasn't been verified.  I believe this
> : means that a lot of information which has been migrated into the
> : reference guide will eventually be removed from MoinMoin.
>
> +1 ... it's just a matter of time/energy to clean things up...
>
>
> https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-WhatShouldandShouldNotbeIncludedinThisDocumentation
>
>
> FWIW: "Emmanuel Stalling" has started doing an audit of the wiki content
> vs the ref guide ... once more folks have a chance to review & dive
> in with edits should be really helpful to cleaning all this up...
>
> https://wiki.apache.org/solr/WikiManualComparison
>
>
>
> -Hoss
> http://www.lucidworks.com/
>

Reply via email to