lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SOLR-4618) Integrate LucidWorks' Solr Reference Guide with Solr documentation
Date Wed, 20 Mar 2013 18:59:16 GMT

    [ https://issues.apache.org/jira/browse/SOLR-4618?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13608008#comment-13608008
] 

Robert Muir commented on SOLR-4618:
-----------------------------------

{quote}
another possibility would be use the confluence wiki to always represent the "live" state
of things, and use confluences PDF exporting to generate a PDF copy on each release.
{quote}

This sounds nicest to me.

{quote}
i think a bigger question is dealing with the 4x (5x, 6x, etc...) branches vs the "trunk"
... do we have a trunk version of the guide we update when moving changes to trunk, and then
copy/paste those into the 4x guide when backporting? (my first thought was to suggest "we
only have a 4x guide and you update it when backporting" but then we wind up not having any
up to date nad accurate docs when 5.0 comes out)
{quote}

I don't know much about confluence but could we have (separate/isolated):
* separate page for minor errata about previous releases (since they would just be PDFs if
we go with that strategy).
* separate page for trunk-only changes.

This way the thing is targetting our "release/stable" branch. Part of using stable is getting
fluid and consistent docs :)

After we release 4.5 or 4.9 or whatever is the last minor one, we work on integrating the
trunk changes before 5.0 and clear that page for 6.0
                
> Integrate LucidWorks' Solr Reference Guide with Solr documentation
> ------------------------------------------------------------------
>
>                 Key: SOLR-4618
>                 URL: https://issues.apache.org/jira/browse/SOLR-4618
>             Project: Solr
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 4.1
>            Reporter: Cassandra Targett
>         Attachments: NewSolrStyle.css, SolrRefGuide4.1-ASF.zip
>
>
> LucidWorks would like to donate the "Apache Solr Reference Guide", maintained by LucidWorks
tech writers, to the Solr community. It was first produced in 2009 as a download-only PDF
for Solr 1.4, but since 2011 it has been online at http://docs.lucidworks.com/display/solr/
and updated for Solr 3.x releases and for Solr 4.0 and 4.1.
> I've prepared an XML export from our Confluence installation, which can be easily imported
into the Apache Confluence installation by someone with system admin rights. The doc has not
yet been updated for 4.2, so it covers Solr 4.1 so far. I'll add some additional technical
notes about the export itself in a comment. 
> Since we use Confluence at LucidWorks, I can also offer assistance getting Confluence
set up, importing this package into it, or any other help needed for the community to start
using this. 

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message