You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-user@lucene.apache.org by Dan Davis <da...@gmail.com> on 2015/01/31 06:59:19 UTC
role of the wiki and cwiki
I've been thinking of https://wiki.apache.org/solr/ as the "Old Wiki" and
https://cwiki.apache.org/confluence/display/solr as the "New Wiki".
I guess that's the wrong way to think about it - Confluence is being used
for the "Solr Reference Guide", and MoinMoin is being used as a wiki.
Is this the correct understanding?
Re: role of the wiki and cwiki
Posted by Anshum Gupta <an...@anshumgupta.net>.
Hi Dan,
I would say that the wiki is old and dated and that gap is only increasing.
I would highly recommend everyone to use the Reference Guide instead of the
wiki, unless there's something that they can't find. In case you are unable
to find something on the wiki, it'd be good to comment on confluence about
the missing content, better still, contribute :-).
Now, about the reference guide. The link you've shared above is always the
next version of the ref guide e.g. right now, all the content there is
w.r.t. 5.0 and is unreleased. The best way to use the reference guide is to
download the ref guide for the version you're using.
On Fri, Jan 30, 2015 at 9:59 PM, Dan Davis <da...@gmail.com> wrote:
> I've been thinking of https://wiki.apache.org/solr/ as the "Old Wiki" and
> https://cwiki.apache.org/confluence/display/solr as the "New Wiki".
>
> I guess that's the wrong way to think about it - Confluence is being used
> for the "Solr Reference Guide", and MoinMoin is being used as a wiki.
>
> Is this the correct understanding?
>
--
Anshum Gupta
http://about.me/anshumgupta
Re: role of the wiki and cwiki
Posted by Chris Hostetter <ho...@fucit.org>.
: of official documentation, but I wonder abstractly how a non-committer then
: should contribute to the documentation. I just did an evaluation of
...
: With current technology, possibilities include:
you pretty much nailed it...
: * Make a comment within Confluence suggesting content or making a
: clarification,
: * Paste text and/or content into a JIRA ticket, or upload an attachment to
: the JIRA ticket.
we've discussed the JIRA path beofre as a way to suggest/format entire new
pages, but aparently that never got mentioned in the appropriate place in
the doc, so i just added it now...
https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-HowtoGiveFeedbackonThisDocumentation
: 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.
Yep, there's always room for improvement -- if you have specific
suggestions for content to add to help make the DIH sections more in depth
then please, please please submit them :)
-Hoss
http://www.lucidworks.com/
Re: role of the wiki and cwiki
Posted by Dan Davis <da...@gmail.com>.
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 <ho...@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/
>
Re: role of the wiki and cwiki
Posted by Chris Hostetter <ho...@fucit.org>.
: 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/
Re: role of the wiki and cwiki
Posted by Shawn Heisey <ap...@elyograg.org>.
On 1/30/2015 10:59 PM, Dan Davis wrote:
> I've been thinking of https://wiki.apache.org/solr/ as the "Old Wiki" and
> https://cwiki.apache.org/confluence/display/solr as the "New Wiki".
>
> I guess that's the wrong way to think about it - Confluence is being used
> for the "Solr Reference Guide", and MoinMoin is being used as a wiki.
>
> Is this the correct understanding?
Yes, your understanding is correct.
Because the Solr Reference Guide is released as official documentation
in PDF form shortly after each new minor Solr version, only committers
have the ability to edit the confluence wiki. Anyone can comment on it,
so we do have a feedback mechanism.
Anyone can edit the MoinMoin wiki, after they ask for edit rights and
provide their username for the Solr portion of that wiki. Asking for
edit permission is typically done via this mailing list or the IRC channel.
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.
Thanks,
Shawn