You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Cassandra Targett (JIRA)" <ji...@apache.org> on 2013/03/20 19:29:15 UTC
[jira] [Commented] (SOLR-4618) Integrate LucidWorks' Solr Reference
Guide with Solr documentation
[ https://issues.apache.org/jira/browse/SOLR-4618?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13607963#comment-13607963 ]
Cassandra Targett commented on SOLR-4618:
-----------------------------------------
A few notes about the export:
# I've tried to remove instances of "LucidWorks" branding, including the copyright notice that appeared on every page. I might have missed some, so if you find any, I can remove them and re-upload or they can be fixed after importing. I also removed all our old page history from years of page edits.
# The export was made with Confluence 3.4.5, which should be all right to import into 3.4.9 (the version used by Apache). If it won't work, I have a trick to make it work.
# I included a relatively quick & dirty stylesheet modeled after the Solr website, which can be easily removed or modified as desired. I'll also attach it to this issue.
# This export has a space key of 'srg41'. If the key isn't changed before import, the Solr Ref Guide for 4.1 will be at http://cwiki.apache.org/confluence/display/srg41, and can't be changed. To maintain a "4.1" version, that might be fine. However, if it would be preferred to change the key to "solr" or "solr41" (or something else), I can do that and re-upload the package.
# There are some Confluence plugins used in the pages that may not be currently installed in the Apache Confluence instance. Rooting all these out would be a huge task and it might be easier if it's imported and then fix what breaks. But, for the record, here are the plugins that I think might cause a problem:
## The Navigation plugin, which provides nav links at the bottom of every page.
## The Link Validator plugin, used on one page currently called "Internal Doc Link Check". It runs through every page, checks every link, and shows the status of each one.
## The Reporting plugin, used to set up the link checking page.
## The Content Formatting plugin, which provides some advanced formatting tools.
## The Table of Contents plugin, which provides TOCs on many pages. I suspect this is automatically included with Confluence, but I mention it in case it's not (lots of pages will look broken if not).
## The Table Plugin, which provides advanced table options, like sorting, row highlighting, etc. There's only one page that uses this, so that could just be fixed after import.
> 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