You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2009/02/19 11:18:03 UTC

[Solr Wiki] Trivial Update of "HowToContribute" by NilsGrunwald

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by NilsGrunwald:
http://wiki.apache.org/solr/HowToContribute

The comment on the change is:
orthograph

------------------------------------------------------------------------------
  
  Solr can always use more/better documentation targeted at end users, most of which is in this wiki where anyone can edit it.  If you see a gap in the Solr documentation, fill it in.  Even if you don't know exactly what to say, ask on the user list and you'll probably get a lot of great responses -- talking informally about how Solr works is something lots of people tend to have time for, but aggregating all of that info into concise cohesive documentation takes a little more work/patience.
  
- If there is a patch in Jira that you think is really great, writing some "user guide" style docs about how it works (or is suppose to work) in the wiki is a great way to help the patch get committed:  It helps serve as a road map for what the "goal" of the issue is, what should be possible for users to do one the issue is resolved; it helps get people who may not understand the low level details get excited about the new functionality; and it can eventually evolve into the final documentation once the code is committed.  (just make sure to link to the issue so people who find your wiki page first know it's not included in Solr's main code line yet).
+ If there is a patch in Jira that you think is really great, writing some "user guide" style docs about how it works (or is suppose to work) in the wiki is a great way to help the patch get committed:  It helps serve as a road map for what the "goal" of the issue is, what should be possible for users to do once the issue is resolved; it helps get people who may not understand the low level details get excited about the new functionality; and it can eventually evolve into the final documentation once the code is committed.  (just make sure to link to the issue so people who find your wiki page first know it's not included in Solr's main code line yet).
  
  = Contributing Code (Features, Big Fixes, Tests, etc...) =