| = How to Contribute to Solr Documentation |
| :page-tocclass: right |
| :page-toclevels: 3 |
| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| |
| The Lucene/Solr project has made it easy for anyone to contribute to the Solr Reference Guide with a patch. |
| |
| The Guide is written in simple AsciiDoc-formatted files, and the source lives in the main Lucene/Solr source repository, right alongside the code. |
| |
| The following sections give an overview of how to work with AsciiDoc-format files, how our documentation is generated, and how to do a Ref Guide release. |
| |
| Once you have a patch you'd like to contribute, you can submit it with a JIRA issue, the same as any other patch. See also the Solr wiki section on https://wiki.apache.org/solr/HowToContribute[How To Contribute] for information on submitting patches. |
| |
| == Working with AsciiDoc Files |
| include::meta-docs/asciidoc-syntax.adoc[leveloffset=+2] |
| |
| include::meta-docs/editing-tools.adoc[leveloffset=+2] |
| |
| == Modifying the Publication Formats |
| The Solr Reference Guide is published in HTML format, using Jekyll and some plugins. |
| |
| include::meta-docs/jekyll.adoc[leveloffset=+2] |
| |
| == How to Publish the Guide |
| // This is the how to publish section: |
| include::meta-docs/publish.adoc[leveloffset=+1] |
