: I was wondering the same thing.  Yesterday I was going to update a
: page on the Solr Wiki and stopped myself after remembering this email
: and feeling unsure if my effort will be thrown away in favour of the
: new Confluence Wiki and new Solr Ref Guide.

Bottom line: 

It's better to write documentation *somewhere* then *no where* just 
becuase you aren't sure where is best.

There was extensive dicusssion in SOLR-4618 about how to use this guide 
moving forward, and what it should mean for the existing MoinMoin guide.  
I've attempted to capture the key elements of that dicussion here...

https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation

In particular, on the subject of the ref guide vs the wiki...

https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-WhatShouldandShouldNotbeIncludedinThisDocumentation
https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-Migrating%22Official%22DocumentationfromMoinMoin

in a nut shell:

 * If you see something wrong in moin moin and only have a few 
   minutes, just fix it. (better then leaving it broken)
 * If you see something in moin moin that is also in the ref 
   guide, delete the sentences from moin moin and link to 
   the ref guide instead
 * If you see something in moin moin that isn't in the ref 
   guide, help migrate that content into the ref guide and 
   link to it from the old moin moin pages
 * if you need to document something totally new, add it to the 
   ref guide.

...but those are just my opinions ... i've been trying to take the lead on 
making progress with getting the infra/processes/guidelines in place for 
being able to manage this doc as a group (so we can all help maintain it 
in a sustainable way moving forward w/o going insane) but i'm just one 
dude with terrible grammer and no real expertise in documntation -- 
everyone needs to help chip in on managing the *content* of the docs or 
we'll just wind up with some useless/stale content that's really easy to 
snapshot everytime we do a release.


-Hoss

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to