Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • the user list (to help others)
  • The commit list (to see changes as they are made)
  • The dev list (to join discussions of changes)
  • The issues list (to track all JIRA issue changes)

Please keep discussions about Solr on list so that everyone benefits. Emailing individual committers with questions about specific Solr issues is discouraged. See http://people.apache.org/~hossman/#private_q.

...

Solr can always use more/better documentation targeted at end users. The 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: Reimagining the Solr Reference Guideis written in Asciidoc format.

The reference guide lives in the solr-ref-guide folder of the git source tree, and evolves together with the code. The process isThe 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 leave a comment on the reference guide page rather than go through the heavyweight process of creating a JIRA and patch.

...

To check out code from Git. (The repositories listed in the commands, below, use the Apache Git repository; however, a GitHub mirror is also available. See Working with GitHub.)

No Format
# clone repository - for non-committers (read-only):
git clone http://gitbox.apache.org/repos/asf/lucene-solr.git

# clone repository - for committers (read/write):
git clone https://gitbox.apache.org/repos/asf/lucene-solr.git

# check out desired branch:
git checkout <branch>

...

Though this leaves added files, which must be removed

Backporting a Contribution

If you wish to backport a contribution to Lucene/Solr,

IDE integration

Both Intellij and Eclipse are supported out of the box.

...