lucene-solr-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Cassandra Targett <ctarg...@apache.org>
Subject Re: [ANNOUNCE] Apache Solr Reference Guide for 6.6 Released
Date Tue, 20 Jun 2017 16:13:19 GMT
I wanted to add a follow-up to my announcement for the Solr 6.6
Reference Guide. This release of the Guide is the first with a new
publication process [1] and A LOT has changed.

First, we have migrated the Ref Guide completely out of Confluence
(aka CWIKI) and now follow a "docs with code" model. This means the
Ref Guide content resides in the same Git repository as the
Lucene/Solr source code. We now treat changes to documentation the
same way we treat any other code change. If you check out the
Lucene/Solr Git repository, you'll also get all of the documentation
and build scripts.

The file format for the "raw" Ref Guide content is AsciiDoc
(Asciidoctor flavor), which is a text markup syntax similar to
Markdown (but with more options than Markdown). We chose this for its
ease of editing - one of our main goals was to knock down barriers for
committers and members of the community to either make or suggest
changes to Solr's official documentation.

This change required us to develop new new tools to publish the Ref
Guide and we can now generate a HTML version that is published at the
same time as the traditional PDF artifact.

The PDF version is available the same way it always has been. The HTML
version will now be available via the Solr website for ongoing access.
If you are on Solr 6.6 for a while, you'll always be able to access
online docs for 6.6 at that URL.

As for the old Ref Guide in Confluence, it's still online for the
foreseeable future, and we are working on a redirect mechanism to
allow search engines to learn the new location. However, all comments
have been disabled and no further content edits will be made there.
(The new HTML version allows comments, though, so we have not taken
that feature away.)

This new approach allows you to contribute to the project more
directly than before. JIRA issues can be filed for any issues you may
find in the documentation, and you are welcome to submit patches if
you have the time to do so.

These changes took a long time to implement, but we hope they are
considered improvements for the entire community. If you have further
suggestions for us, please feel free to file a JIRA issue.

Cassandra

[1] I described more details of many of the changes in a blog post
about 6 weeks ago:
https://lucidworks.com/2017/05/05/reimagining-the-solr-reference-guide/.

On Tue, Jun 20, 2017 at 10:56 AM, Cassandra Targett <ctargett@apache.org> wrote:
> The Lucene PMC is pleased to announce the release of the Solr
> Reference Guide for Solr 6.6.
>
> This 966-page PDF is the definitive guide to using Apache Solr, the
> search server built on Apache Lucene.
>
> The Guide can be downloaded from:
> https://www.apache.org/dyn/closer.cgi/lucene/solr/ref-guide/apache-solr-ref-guide-6.6.pdf
>
> It is also available online at:
> https://lucene.apache.org/solr/guide/6_6/

Mime
View raw message