You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2017/06/20 19:38:21 UTC

[Solr Wiki] Update of "HowToContribute" by ErickErickson

Dear Wiki user,

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

The "HowToContribute" page has been changed by ErickErickson:
https://wiki.apache.org/solr/HowToContribute?action=diff&rev1=113&rev2=114

Comment:
Updated to reflect the Asciidoc change to the Ref Guide.

  If you'd like to volunteer to be the moderator of a mailing list, just contact `listname-owner@lucene...` (ie: `solr-user-owner@lucene...`)
  
  = Write/Improve User Documentation =
- Solr can always use more/better documentation targeted at end users.  The [[https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide|Reference Guide]] is the official documentation, and only committers can modify it, but anyone can comment on it.  There is quite a lot of additional documentation in this wiki, which anyone can edit after creating an account and asking for edit permissions via the solr-user mailing list or the #solr IRC channel on freenode.
  
- If you see a gap or problem in the Reference Guide, comment on the page to bring it to the attention of a committer.  If you see a gap or problem in the documentation on this wiki, 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 and patience.
+ Solr can always use more/better documentation targeted at end users.  The [[https://lucene.apache.org/solr/guide/|Reference Guide]] is the official documentation and has recently been migrated from Confluence to AsciiDoctor (June, 2017 as of Solr 6.6), for background see: [[https://lucidworks.com/2017/05/05/reimagining-the-solr-reference-guide|Reimagining the Solr Reference Guide]]
+ 
+ The biggest change is that documentation now follows the same process as code changes: 
+  * get the source
+  * edit the reference guide (*.adoc files in ...solr/solr-ref-guide/src)
+  * raise a JIRA and submit a patch.
+   * for very minor changes, spelling errors, grammar corrections and the like it's probably better to just comment on the live page rather than go through the heavyweight process of creating a JIRA and patch.
+ 
+ This means that everyone can help improve the Reference Guide by editing these files and seeing your changes exactly as they will appear. Just like the source code, if your patch is approved a committer will have to pick it up. Some helpful instructions are in ../solr/solr-ref-guide/meta-docs. See particularly asciidoc-syntax.adoc and editing-tools.adoc.
+ 
+ You an still comment on pages in the on-line version of the Reference Guide and that's certainly helpful. Contributing a documentation patch is even better. 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 and patience so help is appreciated.
  
  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 this 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).