You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Chris Hostetter <ho...@fucit.org> on 2013/07/22 23:32:43 UTC
DISCUSS: First official Solr documentation release, plan to vote on
wed.
Now that the 4.4 release vote is official and gradually making it's way to
the mirrors, I'd like to draw attention to the efforts that have been made
to get the "Solr Reference Guide" into releasable shape, so that we can
plan on holding a VOTE to release the "4.4" version ASAP...
https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide
https://people.apache.org/~hossman/apache-solr-ref-guide-snapshot.pdf
TL;DR: I plan to call a vote to formaly release this doc in ~40 hours.
Please help out by reviewing/improving the content -- especially if one of
the subtasks of SOLR-5036 is asigned to you (because that means you
already agreed you would).
- - -
For those of you who haven't been following along closely, there were a
lot of hicups related to the Apache Confluence instance that slowed us
down on getting hte RefGuide content donated by LucidWorks up and running
and editable. Some of those issues are still outstanding, notably because
the ASF is still in the process of trying ot upgrade to Confluence 5.x,
and that process is on hold indefinitely (See SOLR-4618 and it's subtasks
for history) which means we may have to re-visit a lot of little things
once the Confluence upgrade is complete.
In the meantime the Ref Guide is in fact up and live and and editable, and
progress has been made on two fronts:
* Getting the doc up to date with Solr 4.4 (SOLR-5036)
* Getting a process in place to release/publish the doc with each
minor solr release.
There are 4-5 major additions needed to the doc to cover Solr 4.4
adequately, see the children of SOLR-5036 for details. My hope is that
the folks who volunteered to help out in writing those new sections of the
doc can work on their edits over the next ~40 hours or so, and then on Wed
morning (my time) I plan to vall a VOTE to formally release this doc
(i'm volunteering to be the "Doc RM" this time arround)...
http://s.apache.org/exs
If you are one of the people assigned an outstanding doc issue, please
speak up if you don't think you'll have your edits finished by then, or if
you would like assistance with structure, wording or formatting...
* SOLR-5059 - sarowe - schemaless & schema REST
* SOLR-5060 - miller - HDFS
* SOLR-5061 - erick - new solr.xml format
* SOLR-5062 - shalin - shard splitting review & new deleteshard cmd
* SOLR-5063 - grant - UI screen for adding docs
Even if you are not one of the people listed above, there is still a
lot you can do to help out...
* Reviewing any/all sections of the guide looking for content
improvements that can be made (edit or post comments directly on the
affected pages as you find them)
* Reviewing the snapshot PDF looking for *general* formatting problems
that need to be addressed. (reply to this thread or open a Jira)
* Reviewing & sanity checking the process docs for how we will be
maintaining & releasing hte guide looking for potential probems
(edit or post comments if you see problems)...
https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation
https://cwiki.apache.org/confluence/display/solr/Internal+-+How+To+Publish+This+Documentation
If anyone has any general comments / concerns, please reply here.
-Hoss
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Dmitry Kan <dm...@gmail.com>.
OK, thanks, Hoss, I can get by with the comments. A jira is perhaps too
much for fixing a typo ;)
On 24 July 2013 18:32, Chris Hostetter <ho...@fucit.org> wrote:
>
> : Could I have write access to the pages, thought to start by fixing couple
> : typos. Or should I leave them as comments?
>
> Please leave comments on specific pages, or open Jira isues for larger
> concerns.
>
> The doc is only directly editable by committers in order to be able to be
> able to officially release it...
>
>
> https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-WhoCanEditThisDocumentation
>
>
> -Hoss
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Chris Hostetter <ho...@fucit.org>.
: Could I have write access to the pages, thought to start by fixing couple
: typos. Or should I leave them as comments?
Please leave comments on specific pages, or open Jira isues for larger
concerns.
The doc is only directly editable by committers in order to be able to be
able to officially release it...
https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-WhoCanEditThisDocumentation
-Hoss
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Dmitry Kan <dm...@gmail.com>.
Erick:
it's this e-mail.
On 24 July 2013 15:00, Erick Erickson <er...@gmail.com> wrote:
> Dmitry:
>
> What's your Confluence login?
>
> Erick
>
> On Wed, Jul 24, 2013 at 7:08 AM, Dmitry Kan <dm...@gmail.com>
> wrote:
> > Hi Hoss,
> >
> > Could I have write access to the pages, thought to start by fixing couple
> > typos. Or should I leave them as comments?
> >
> > Thanks,
> > Dmitry Kan
> >
> >
> >
> > On 23 July 2013 00:32, Chris Hostetter <ho...@fucit.org> wrote:
> >>
> >>
> >> Now that the 4.4 release vote is official and gradually making it's way
> to
> >> the mirrors, I'd like to draw attention to the efforts that have been
> made
> >> to get the "Solr Reference Guide" into releasable shape, so that we can
> plan
> >> on holding a VOTE to release the "4.4" version ASAP...
> >>
> >>
> >>
> https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide
> >> https://people.apache.org/~hossman/apache-solr-ref-guide-snapshot.pdf
> >>
> >> TL;DR: I plan to call a vote to formaly release this doc in ~40 hours.
> >> Please help out by reviewing/improving the content -- especially if one
> of
> >> the subtasks of SOLR-5036 is asigned to you (because that means you
> already
> >> agreed you would).
> >>
> >> - - -
> >>
> >> For those of you who haven't been following along closely, there were a
> >> lot of hicups related to the Apache Confluence instance that slowed us
> down
> >> on getting hte RefGuide content donated by LucidWorks up and running and
> >> editable. Some of those issues are still outstanding, notably because
> the
> >> ASF is still in the process of trying ot upgrade to Confluence 5.x, and
> that
> >> process is on hold indefinitely (See SOLR-4618 and it's subtasks for
> >> history) which means we may have to re-visit a lot of little things
> once the
> >> Confluence upgrade is complete.
> >>
> >> In the meantime the Ref Guide is in fact up and live and and editable,
> and
> >> progress has been made on two fronts:
> >>
> >> * Getting the doc up to date with Solr 4.4 (SOLR-5036)
> >> * Getting a process in place to release/publish the doc with each
> >> minor solr release.
> >>
> >> There are 4-5 major additions needed to the doc to cover Solr 4.4
> >> adequately, see the children of SOLR-5036 for details. My hope is that
> the
> >> folks who volunteered to help out in writing those new sections of the
> doc
> >> can work on their edits over the next ~40 hours or so, and then on Wed
> >> morning (my time) I plan to vall a VOTE to formally release this doc
> (i'm
> >> volunteering to be the "Doc RM" this time arround)...
> >>
> >> http://s.apache.org/exs
> >>
> >> If you are one of the people assigned an outstanding doc issue, please
> >> speak up if you don't think you'll have your edits finished by then, or
> if
> >> you would like assistance with structure, wording or formatting...
> >>
> >> * SOLR-5059 - sarowe - schemaless & schema REST
> >> * SOLR-5060 - miller - HDFS
> >> * SOLR-5061 - erick - new solr.xml format
> >> * SOLR-5062 - shalin - shard splitting review & new deleteshard cmd
> >> * SOLR-5063 - grant - UI screen for adding docs
> >>
> >> Even if you are not one of the people listed above, there is still a lot
> >> you can do to help out...
> >>
> >> * Reviewing any/all sections of the guide looking for content
> >> improvements that can be made (edit or post comments directly on the
> >> affected pages as you find them)
> >>
> >> * Reviewing the snapshot PDF looking for *general* formatting problems
> >> that need to be addressed. (reply to this thread or open a Jira)
> >>
> >> * Reviewing & sanity checking the process docs for how we will be
> >> maintaining & releasing hte guide looking for potential probems
> >> (edit or post comments if you see problems)...
> >>
> >>
> >>
> https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation
> >>
> >>
> https://cwiki.apache.org/confluence/display/solr/Internal+-+How+To+Publish+This+Documentation
> >>
> >>
> >> If anyone has any general comments / concerns, please reply here.
> >>
> >> -Hoss
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> >> For additional commands, e-mail: dev-help@lucene.apache.org
> >>
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Erick Erickson <er...@gmail.com>.
Dmitry:
What's your Confluence login?
Erick
On Wed, Jul 24, 2013 at 7:08 AM, Dmitry Kan <dm...@gmail.com> wrote:
> Hi Hoss,
>
> Could I have write access to the pages, thought to start by fixing couple
> typos. Or should I leave them as comments?
>
> Thanks,
> Dmitry Kan
>
>
>
> On 23 July 2013 00:32, Chris Hostetter <ho...@fucit.org> wrote:
>>
>>
>> Now that the 4.4 release vote is official and gradually making it's way to
>> the mirrors, I'd like to draw attention to the efforts that have been made
>> to get the "Solr Reference Guide" into releasable shape, so that we can plan
>> on holding a VOTE to release the "4.4" version ASAP...
>>
>>
>> https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide
>> https://people.apache.org/~hossman/apache-solr-ref-guide-snapshot.pdf
>>
>> TL;DR: I plan to call a vote to formaly release this doc in ~40 hours.
>> Please help out by reviewing/improving the content -- especially if one of
>> the subtasks of SOLR-5036 is asigned to you (because that means you already
>> agreed you would).
>>
>> - - -
>>
>> For those of you who haven't been following along closely, there were a
>> lot of hicups related to the Apache Confluence instance that slowed us down
>> on getting hte RefGuide content donated by LucidWorks up and running and
>> editable. Some of those issues are still outstanding, notably because the
>> ASF is still in the process of trying ot upgrade to Confluence 5.x, and that
>> process is on hold indefinitely (See SOLR-4618 and it's subtasks for
>> history) which means we may have to re-visit a lot of little things once the
>> Confluence upgrade is complete.
>>
>> In the meantime the Ref Guide is in fact up and live and and editable, and
>> progress has been made on two fronts:
>>
>> * Getting the doc up to date with Solr 4.4 (SOLR-5036)
>> * Getting a process in place to release/publish the doc with each
>> minor solr release.
>>
>> There are 4-5 major additions needed to the doc to cover Solr 4.4
>> adequately, see the children of SOLR-5036 for details. My hope is that the
>> folks who volunteered to help out in writing those new sections of the doc
>> can work on their edits over the next ~40 hours or so, and then on Wed
>> morning (my time) I plan to vall a VOTE to formally release this doc (i'm
>> volunteering to be the "Doc RM" this time arround)...
>>
>> http://s.apache.org/exs
>>
>> If you are one of the people assigned an outstanding doc issue, please
>> speak up if you don't think you'll have your edits finished by then, or if
>> you would like assistance with structure, wording or formatting...
>>
>> * SOLR-5059 - sarowe - schemaless & schema REST
>> * SOLR-5060 - miller - HDFS
>> * SOLR-5061 - erick - new solr.xml format
>> * SOLR-5062 - shalin - shard splitting review & new deleteshard cmd
>> * SOLR-5063 - grant - UI screen for adding docs
>>
>> Even if you are not one of the people listed above, there is still a lot
>> you can do to help out...
>>
>> * Reviewing any/all sections of the guide looking for content
>> improvements that can be made (edit or post comments directly on the
>> affected pages as you find them)
>>
>> * Reviewing the snapshot PDF looking for *general* formatting problems
>> that need to be addressed. (reply to this thread or open a Jira)
>>
>> * Reviewing & sanity checking the process docs for how we will be
>> maintaining & releasing hte guide looking for potential probems
>> (edit or post comments if you see problems)...
>>
>>
>> https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation
>>
>> https://cwiki.apache.org/confluence/display/solr/Internal+-+How+To+Publish+This+Documentation
>>
>>
>> If anyone has any general comments / concerns, please reply here.
>>
>> -Hoss
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
>> For additional commands, e-mail: dev-help@lucene.apache.org
>>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Dmitry Kan <dm...@gmail.com>.
Hi Hoss,
Could I have write access to the pages, thought to start by fixing couple
typos. Or should I leave them as comments?
Thanks,
Dmitry Kan
On 23 July 2013 00:32, Chris Hostetter <ho...@fucit.org> wrote:
>
> Now that the 4.4 release vote is official and gradually making it's way to
> the mirrors, I'd like to draw attention to the efforts that have been made
> to get the "Solr Reference Guide" into releasable shape, so that we can
> plan on holding a VOTE to release the "4.4" version ASAP...
>
> https://cwiki.apache.org/**confluence/display/solr/**
> Apache+Solr+Reference+Guide<https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide>
> https://people.apache.org/~**hossman/apache-solr-ref-guide-**snapshot.pdf<https://people.apache.org/~hossman/apache-solr-ref-guide-snapshot.pdf>
>
> TL;DR: I plan to call a vote to formaly release this doc in ~40 hours.
> Please help out by reviewing/improving the content -- especially if one of
> the subtasks of SOLR-5036 is asigned to you (because that means you already
> agreed you would).
>
> - - -
>
> For those of you who haven't been following along closely, there were a
> lot of hicups related to the Apache Confluence instance that slowed us down
> on getting hte RefGuide content donated by LucidWorks up and running and
> editable. Some of those issues are still outstanding, notably because the
> ASF is still in the process of trying ot upgrade to Confluence 5.x, and
> that process is on hold indefinitely (See SOLR-4618 and it's subtasks for
> history) which means we may have to re-visit a lot of little things once
> the Confluence upgrade is complete.
>
> In the meantime the Ref Guide is in fact up and live and and editable, and
> progress has been made on two fronts:
>
> * Getting the doc up to date with Solr 4.4 (SOLR-5036)
> * Getting a process in place to release/publish the doc with each
> minor solr release.
>
> There are 4-5 major additions needed to the doc to cover Solr 4.4
> adequately, see the children of SOLR-5036 for details. My hope is that the
> folks who volunteered to help out in writing those new sections of the doc
> can work on their edits over the next ~40 hours or so, and then on Wed
> morning (my time) I plan to vall a VOTE to formally release this doc (i'm
> volunteering to be the "Doc RM" this time arround)...
>
> http://s.apache.org/exs
>
> If you are one of the people assigned an outstanding doc issue, please
> speak up if you don't think you'll have your edits finished by then, or if
> you would like assistance with structure, wording or formatting...
>
> * SOLR-5059 - sarowe - schemaless & schema REST
> * SOLR-5060 - miller - HDFS
> * SOLR-5061 - erick - new solr.xml format
> * SOLR-5062 - shalin - shard splitting review & new deleteshard cmd
> * SOLR-5063 - grant - UI screen for adding docs
>
> Even if you are not one of the people listed above, there is still a lot
> you can do to help out...
>
> * Reviewing any/all sections of the guide looking for content
> improvements that can be made (edit or post comments directly on the
> affected pages as you find them)
>
> * Reviewing the snapshot PDF looking for *general* formatting problems
> that need to be addressed. (reply to this thread or open a Jira)
>
> * Reviewing & sanity checking the process docs for how we will be
> maintaining & releasing hte guide looking for potential probems
> (edit or post comments if you see problems)...
>
> https://cwiki.apache.org/**confluence/display/solr/**
> Internal+-+Maintaining+**Documentation<https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation>
> https://cwiki.apache.org/**confluence/display/solr/**
> Internal+-+How+To+Publish+**This+Documentation<https://cwiki.apache.org/confluence/display/solr/Internal+-+How+To+Publish+This+Documentation>
>
>
> If anyone has any general comments / concerns, please reply here.
>
> -Hoss
>
> ------------------------------**------------------------------**---------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.**org<de...@lucene.apache.org>
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Chris Hostetter <ho...@fucit.org>.
: don't have to write this idea another 6 times as I find these, one
: possible solution that just occurred to me is to reduce the font size
: of those examples - in the PDF they appear to be larger than the
: regular text, so I think there's room for a point or two reduction. I
: don't know if that will solve it, though.
I haven't yet figured out a way to modify the font size of code blocks yet
via hte CSS (since we don't have access to the intermediate HTML it's kind
of a pain) so for now i'm just abreviating these large blocks...
All of the blocks i've seen so far that are problematic are so long they
don't fit on a single page, and it looks like once one page break is
inserted, it gets confused as to how much room it has at the bottom of hte
second page. (i experimented with shortening one and the amount of empty
lines shifted, but was still here until the whole thing was small enough
to fit on one page)
-Hoss
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Cassandra Targett <ca...@gmail.com>.
I'm looking through the PDF and finding a few spots I didn't see
before where large amounts of blank text is getting inserted into the
end of a code block (right before the last 2-5 lines, like some sort
of widowing, even though what gets pushed to the next page would fit).
I'm commenting on those pages and keeping a list of them, but so I
don't have to write this idea another 6 times as I find these, one
possible solution that just occurred to me is to reduce the font size
of those examples - in the PDF they appear to be larger than the
regular text, so I think there's room for a point or two reduction. I
don't know if that will solve it, though.
> https://people.apache.org/~hossman/apache-solr-ref-guide-snapshot.pdf
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Dmitry Kan <dm...@gmail.com>.
thanks. There are a few more that I could handle before calling it day.
On 24 July 2013 22:02, Shalin Shekhar Mangar <sh...@gmail.com> wrote:
>
> On Thu, Jul 25, 2013 at 12:26 AM, Dmitry Kan <dm...@gmail.com>wrote:
>
>>
>> I started reading through and commenting on typos, where found. Do you
>> get notifs of those?
>>
>
> I fixed the two you reported recently.
>
> --
> Regards,
> Shalin Shekhar Mangar.
>
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Shalin Shekhar Mangar <sh...@gmail.com>.
On Thu, Jul 25, 2013 at 12:26 AM, Dmitry Kan <dm...@gmail.com>wrote:
>
> I started reading through and commenting on typos, where found. Do you get
> notifs of those?
>
I fixed the two you reported recently.
--
Regards,
Shalin Shekhar Mangar.
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Dmitry Kan <dm...@gmail.com>.
Hi Hoss,
I started reading through and commenting on typos, where found. Do you get
notifs of those?
On 24 July 2013 20:45, Chris Hostetter <ho...@fucit.org> wrote:
>
> : TL;DR: I plan to call a vote to formaly release this doc in ~40 hours.
> Please
> : help out by reviewing/improving the content -- especially if one of the
>
> It looks like all the new major additions are complete, I'll hold off on
> cutting hte RC for a couple more hours to give folks some more time to
> review looking for typos/tweaks -- I've updated my PDF snapshot so folks
> can review the final formatting, or you can browse the dynamic site and
> post any comments directly on the applicable pages...
>
>
> https://people.apache.org/~hossman/apache-solr-ref-guide-snapshot.pdf
> https://cwiki.apache.org/confluence/display/solr/
>
>
> -Hoss
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>
Re: DISCUSS: First official Solr documentation release, plan to vote
on wed.
Posted by Chris Hostetter <ho...@fucit.org>.
: TL;DR: I plan to call a vote to formaly release this doc in ~40 hours. Please
: help out by reviewing/improving the content -- especially if one of the
It looks like all the new major additions are complete, I'll hold off on
cutting hte RC for a couple more hours to give folks some more time to
review looking for typos/tweaks -- I've updated my PDF snapshot so folks
can review the final formatting, or you can browse the dynamic site and
post any comments directly on the applicable pages...
https://people.apache.org/~hossman/apache-solr-ref-guide-snapshot.pdf
https://cwiki.apache.org/confluence/display/solr/
-Hoss
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org