You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucenenet.apache.org by Troy Howard <th...@gmail.com> on 2013/01/09 02:24:05 UTC

Re: 3.0.3 release documentation

I went ahead and built docs using doxygen for the 3.0.3 release and pushed
those changed to the public site. The referenced link
http://lucenenet.apache.org/docs/3.0.3/Index.html works now.

I didn't build a CHM because I'm using a Mac, and couldn't find anything
open source/*NIX friendly to build a CHM from that. Now that the HTML docs
are built, making a CHM of them should be pretty easy, if you're on
Windows. I can try to do that in the next day or two if I can find my way
to a Windows machine.

Thanks,
Troy



On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
currens.chris@gmail.com> wrote:

> I was looking at the readme.txt file on our GItHub mirror, and it's saying
> we have documentation up on
> http://lucenenet.apache.org/docs/3.0.3/Index.html and
> http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of these
> links
> are broken.  How can we get the 3.0.3 documentation in those places?
>
>
> Thanks,
> Christopher
>

RE: 3.0.3 release documentation

Posted by Prescott Nasser <ge...@hotmail.com>.
Thanks Chris for getting that up
 > Date: Fri, 11 Jan 2013 14:33:25 -0800
> Subject: Re: 3.0.3 release documentation
> From: currens.chris@gmail.com
> To: dev@lucenenet.apache.org
> 
> Thanks for getting this up Troy.  I got a CHM up, so the link isn't dead
> anymore.  I only did the core documentation though, it doesn't include any
> Contrib docs right now...I'm not even sure what state those xml comments
> are in.
> 
> 
> Thanks,
> Christopher
> 
> 
> On Fri, Jan 11, 2013 at 10:47 AM, Troy Howard <th...@gmail.com> wrote:
> 
> > Well, I'd say a CHM is not needed. IMO, it's kind of an anachronism. But
> > since the release notes for 3.0.3 do reference one as existing at a certain
> > URL, it makes sense to make that link not be broken. In future releases we
> > can just reference the online docs.
> >
> > Thanks,
> > Troy
> >
> >
> > On Thu, Jan 10, 2013 at 11:03 PM, Prescott Nasser <geobmx540@hotmail.com
> > >wrote:
> >
> > > I could do it (if someone pointed me to a good how-do). But, do we need
> > > one with online documentation? Also, thanks Troy for getting this up
> > >  > From: thoward37@gmail.com
> > > > Date: Thu, 10 Jan 2013 22:35:51 -0800
> > > > Subject: Re: 3.0.3 release documentation
> > > > To: dev@lucenenet.apache.org
> > > >
> > > > Fixed. Still need a CHM... anyone have a Windows box handy?
> > > >
> > > >
> > > > On Wed, Jan 9, 2013 at 10:29 AM, Troy Howard <th...@gmail.com>
> > > wrote:
> > > >
> > > > > Good catch! So, since the link in the docs is uppercase, I need to
> > fix
> > > all
> > > > > to be ucase, not lcase. I'll sed s/Index.html/index.html/g the the
> > > files
> > > > > and recommit/publish.
> > > > >
> > > > > Thanks,
> > > > > Troy
> > > > >
> > > > > On Wed, Jan 9, 2013 at 1:51 AM, Andy Pook <an...@gmail.com>
> > wrote:
> > > > >
> > > > >> Nice.
> > > > >> One tiny bug. I think "Index.html" should probably have a lower case
> > > i.
> > > > >> Currently the link to "Main Page" doesn't work (ie 404).
> > > > >>
> > > > >> Cheers
> > > > >>
> > > > >>
> > > > >> On 9 January 2013 01:24, Troy Howard <th...@gmail.com> wrote:
> > > > >>
> > > > >> > I went ahead and built docs using doxygen for the 3.0.3 release
> > and
> > > > >> pushed
> > > > >> > those changed to the public site. The referenced link
> > > > >> > http://lucenenet.apache.org/docs/3.0.3/Index.html works now.
> > > > >> >
> > > > >> > I didn't build a CHM because I'm using a Mac, and couldn't find
> > > anything
> > > > >> > open source/*NIX friendly to build a CHM from that. Now that the
> > > HTML
> > > > >> docs
> > > > >> > are built, making a CHM of them should be pretty easy, if you're
> > on
> > > > >> > Windows. I can try to do that in the next day or two if I can find
> > > my
> > > > >> way
> > > > >> > to a Windows machine.
> > > > >> >
> > > > >> > Thanks,
> > > > >> > Troy
> > > > >> >
> > > > >> >
> > > > >> >
> > > > >> > On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
> > > > >> > currens.chris@gmail.com> wrote:
> > > > >> >
> > > > >> > > I was looking at the readme.txt file on our GItHub mirror, and
> > > it's
> > > > >> > saying
> > > > >> > > we have documentation up on
> > > > >> > > http://lucenenet.apache.org/docs/3.0.3/Index.html and
> > > > >> > > http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of
> > > these
> > > > >> > > links
> > > > >> > > are broken.  How can we get the 3.0.3 documentation in those
> > > places?
> > > > >> > >
> > > > >> > >
> > > > >> > > Thanks,
> > > > >> > > Christopher
> > > > >> > >
> > > > >> >
> > > > >>
> > > > >
> > > > >
> > >
> > >
> >
 		 	   		  

Re: 3.0.3 release documentation

Posted by Christopher Currens <cu...@gmail.com>.
Thanks for getting this up Troy.  I got a CHM up, so the link isn't dead
anymore.  I only did the core documentation though, it doesn't include any
Contrib docs right now...I'm not even sure what state those xml comments
are in.


Thanks,
Christopher


On Fri, Jan 11, 2013 at 10:47 AM, Troy Howard <th...@gmail.com> wrote:

> Well, I'd say a CHM is not needed. IMO, it's kind of an anachronism. But
> since the release notes for 3.0.3 do reference one as existing at a certain
> URL, it makes sense to make that link not be broken. In future releases we
> can just reference the online docs.
>
> Thanks,
> Troy
>
>
> On Thu, Jan 10, 2013 at 11:03 PM, Prescott Nasser <geobmx540@hotmail.com
> >wrote:
>
> > I could do it (if someone pointed me to a good how-do). But, do we need
> > one with online documentation? Also, thanks Troy for getting this up
> >  > From: thoward37@gmail.com
> > > Date: Thu, 10 Jan 2013 22:35:51 -0800
> > > Subject: Re: 3.0.3 release documentation
> > > To: dev@lucenenet.apache.org
> > >
> > > Fixed. Still need a CHM... anyone have a Windows box handy?
> > >
> > >
> > > On Wed, Jan 9, 2013 at 10:29 AM, Troy Howard <th...@gmail.com>
> > wrote:
> > >
> > > > Good catch! So, since the link in the docs is uppercase, I need to
> fix
> > all
> > > > to be ucase, not lcase. I'll sed s/Index.html/index.html/g the the
> > files
> > > > and recommit/publish.
> > > >
> > > > Thanks,
> > > > Troy
> > > >
> > > > On Wed, Jan 9, 2013 at 1:51 AM, Andy Pook <an...@gmail.com>
> wrote:
> > > >
> > > >> Nice.
> > > >> One tiny bug. I think "Index.html" should probably have a lower case
> > i.
> > > >> Currently the link to "Main Page" doesn't work (ie 404).
> > > >>
> > > >> Cheers
> > > >>
> > > >>
> > > >> On 9 January 2013 01:24, Troy Howard <th...@gmail.com> wrote:
> > > >>
> > > >> > I went ahead and built docs using doxygen for the 3.0.3 release
> and
> > > >> pushed
> > > >> > those changed to the public site. The referenced link
> > > >> > http://lucenenet.apache.org/docs/3.0.3/Index.html works now.
> > > >> >
> > > >> > I didn't build a CHM because I'm using a Mac, and couldn't find
> > anything
> > > >> > open source/*NIX friendly to build a CHM from that. Now that the
> > HTML
> > > >> docs
> > > >> > are built, making a CHM of them should be pretty easy, if you're
> on
> > > >> > Windows. I can try to do that in the next day or two if I can find
> > my
> > > >> way
> > > >> > to a Windows machine.
> > > >> >
> > > >> > Thanks,
> > > >> > Troy
> > > >> >
> > > >> >
> > > >> >
> > > >> > On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
> > > >> > currens.chris@gmail.com> wrote:
> > > >> >
> > > >> > > I was looking at the readme.txt file on our GItHub mirror, and
> > it's
> > > >> > saying
> > > >> > > we have documentation up on
> > > >> > > http://lucenenet.apache.org/docs/3.0.3/Index.html and
> > > >> > > http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of
> > these
> > > >> > > links
> > > >> > > are broken.  How can we get the 3.0.3 documentation in those
> > places?
> > > >> > >
> > > >> > >
> > > >> > > Thanks,
> > > >> > > Christopher
> > > >> > >
> > > >> >
> > > >>
> > > >
> > > >
> >
> >
>

Re: 3.0.3 release documentation

Posted by Troy Howard <th...@gmail.com>.
Well, I'd say a CHM is not needed. IMO, it's kind of an anachronism. But
since the release notes for 3.0.3 do reference one as existing at a certain
URL, it makes sense to make that link not be broken. In future releases we
can just reference the online docs.

Thanks,
Troy


On Thu, Jan 10, 2013 at 11:03 PM, Prescott Nasser <ge...@hotmail.com>wrote:

> I could do it (if someone pointed me to a good how-do). But, do we need
> one with online documentation? Also, thanks Troy for getting this up
>  > From: thoward37@gmail.com
> > Date: Thu, 10 Jan 2013 22:35:51 -0800
> > Subject: Re: 3.0.3 release documentation
> > To: dev@lucenenet.apache.org
> >
> > Fixed. Still need a CHM... anyone have a Windows box handy?
> >
> >
> > On Wed, Jan 9, 2013 at 10:29 AM, Troy Howard <th...@gmail.com>
> wrote:
> >
> > > Good catch! So, since the link in the docs is uppercase, I need to fix
> all
> > > to be ucase, not lcase. I'll sed s/Index.html/index.html/g the the
> files
> > > and recommit/publish.
> > >
> > > Thanks,
> > > Troy
> > >
> > > On Wed, Jan 9, 2013 at 1:51 AM, Andy Pook <an...@gmail.com> wrote:
> > >
> > >> Nice.
> > >> One tiny bug. I think "Index.html" should probably have a lower case
> i.
> > >> Currently the link to "Main Page" doesn't work (ie 404).
> > >>
> > >> Cheers
> > >>
> > >>
> > >> On 9 January 2013 01:24, Troy Howard <th...@gmail.com> wrote:
> > >>
> > >> > I went ahead and built docs using doxygen for the 3.0.3 release and
> > >> pushed
> > >> > those changed to the public site. The referenced link
> > >> > http://lucenenet.apache.org/docs/3.0.3/Index.html works now.
> > >> >
> > >> > I didn't build a CHM because I'm using a Mac, and couldn't find
> anything
> > >> > open source/*NIX friendly to build a CHM from that. Now that the
> HTML
> > >> docs
> > >> > are built, making a CHM of them should be pretty easy, if you're on
> > >> > Windows. I can try to do that in the next day or two if I can find
> my
> > >> way
> > >> > to a Windows machine.
> > >> >
> > >> > Thanks,
> > >> > Troy
> > >> >
> > >> >
> > >> >
> > >> > On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
> > >> > currens.chris@gmail.com> wrote:
> > >> >
> > >> > > I was looking at the readme.txt file on our GItHub mirror, and
> it's
> > >> > saying
> > >> > > we have documentation up on
> > >> > > http://lucenenet.apache.org/docs/3.0.3/Index.html and
> > >> > > http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of
> these
> > >> > > links
> > >> > > are broken.  How can we get the 3.0.3 documentation in those
> places?
> > >> > >
> > >> > >
> > >> > > Thanks,
> > >> > > Christopher
> > >> > >
> > >> >
> > >>
> > >
> > >
>
>

RE: 3.0.3 release documentation

Posted by Prescott Nasser <ge...@hotmail.com>.
I could do it (if someone pointed me to a good how-do). But, do we need one with online documentation? Also, thanks Troy for getting this up
 > From: thoward37@gmail.com
> Date: Thu, 10 Jan 2013 22:35:51 -0800
> Subject: Re: 3.0.3 release documentation
> To: dev@lucenenet.apache.org
> 
> Fixed. Still need a CHM... anyone have a Windows box handy?
> 
> 
> On Wed, Jan 9, 2013 at 10:29 AM, Troy Howard <th...@gmail.com> wrote:
> 
> > Good catch! So, since the link in the docs is uppercase, I need to fix all
> > to be ucase, not lcase. I'll sed s/Index.html/index.html/g the the files
> > and recommit/publish.
> >
> > Thanks,
> > Troy
> >
> > On Wed, Jan 9, 2013 at 1:51 AM, Andy Pook <an...@gmail.com> wrote:
> >
> >> Nice.
> >> One tiny bug. I think "Index.html" should probably have a lower case i.
> >> Currently the link to "Main Page" doesn't work (ie 404).
> >>
> >> Cheers
> >>
> >>
> >> On 9 January 2013 01:24, Troy Howard <th...@gmail.com> wrote:
> >>
> >> > I went ahead and built docs using doxygen for the 3.0.3 release and
> >> pushed
> >> > those changed to the public site. The referenced link
> >> > http://lucenenet.apache.org/docs/3.0.3/Index.html works now.
> >> >
> >> > I didn't build a CHM because I'm using a Mac, and couldn't find anything
> >> > open source/*NIX friendly to build a CHM from that. Now that the HTML
> >> docs
> >> > are built, making a CHM of them should be pretty easy, if you're on
> >> > Windows. I can try to do that in the next day or two if I can find my
> >> way
> >> > to a Windows machine.
> >> >
> >> > Thanks,
> >> > Troy
> >> >
> >> >
> >> >
> >> > On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
> >> > currens.chris@gmail.com> wrote:
> >> >
> >> > > I was looking at the readme.txt file on our GItHub mirror, and it's
> >> > saying
> >> > > we have documentation up on
> >> > > http://lucenenet.apache.org/docs/3.0.3/Index.html and
> >> > > http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of these
> >> > > links
> >> > > are broken.  How can we get the 3.0.3 documentation in those places?
> >> > >
> >> > >
> >> > > Thanks,
> >> > > Christopher
> >> > >
> >> >
> >>
> >
> >
 		 	   		  

Re: 3.0.3 release documentation

Posted by Troy Howard <th...@gmail.com>.
Fixed. Still need a CHM... anyone have a Windows box handy?


On Wed, Jan 9, 2013 at 10:29 AM, Troy Howard <th...@gmail.com> wrote:

> Good catch! So, since the link in the docs is uppercase, I need to fix all
> to be ucase, not lcase. I'll sed s/Index.html/index.html/g the the files
> and recommit/publish.
>
> Thanks,
> Troy
>
> On Wed, Jan 9, 2013 at 1:51 AM, Andy Pook <an...@gmail.com> wrote:
>
>> Nice.
>> One tiny bug. I think "Index.html" should probably have a lower case i.
>> Currently the link to "Main Page" doesn't work (ie 404).
>>
>> Cheers
>>
>>
>> On 9 January 2013 01:24, Troy Howard <th...@gmail.com> wrote:
>>
>> > I went ahead and built docs using doxygen for the 3.0.3 release and
>> pushed
>> > those changed to the public site. The referenced link
>> > http://lucenenet.apache.org/docs/3.0.3/Index.html works now.
>> >
>> > I didn't build a CHM because I'm using a Mac, and couldn't find anything
>> > open source/*NIX friendly to build a CHM from that. Now that the HTML
>> docs
>> > are built, making a CHM of them should be pretty easy, if you're on
>> > Windows. I can try to do that in the next day or two if I can find my
>> way
>> > to a Windows machine.
>> >
>> > Thanks,
>> > Troy
>> >
>> >
>> >
>> > On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
>> > currens.chris@gmail.com> wrote:
>> >
>> > > I was looking at the readme.txt file on our GItHub mirror, and it's
>> > saying
>> > > we have documentation up on
>> > > http://lucenenet.apache.org/docs/3.0.3/Index.html and
>> > > http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of these
>> > > links
>> > > are broken.  How can we get the 3.0.3 documentation in those places?
>> > >
>> > >
>> > > Thanks,
>> > > Christopher
>> > >
>> >
>>
>
>

Re: 3.0.3 release documentation

Posted by Troy Howard <th...@gmail.com>.
Good catch! So, since the link in the docs is uppercase, I need to fix all
to be ucase, not lcase. I'll sed s/Index.html/index.html/g the the files
and recommit/publish.

Thanks,
Troy

On Wed, Jan 9, 2013 at 1:51 AM, Andy Pook <an...@gmail.com> wrote:

> Nice.
> One tiny bug. I think "Index.html" should probably have a lower case i.
> Currently the link to "Main Page" doesn't work (ie 404).
>
> Cheers
>
>
> On 9 January 2013 01:24, Troy Howard <th...@gmail.com> wrote:
>
> > I went ahead and built docs using doxygen for the 3.0.3 release and
> pushed
> > those changed to the public site. The referenced link
> > http://lucenenet.apache.org/docs/3.0.3/Index.html works now.
> >
> > I didn't build a CHM because I'm using a Mac, and couldn't find anything
> > open source/*NIX friendly to build a CHM from that. Now that the HTML
> docs
> > are built, making a CHM of them should be pretty easy, if you're on
> > Windows. I can try to do that in the next day or two if I can find my way
> > to a Windows machine.
> >
> > Thanks,
> > Troy
> >
> >
> >
> > On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
> > currens.chris@gmail.com> wrote:
> >
> > > I was looking at the readme.txt file on our GItHub mirror, and it's
> > saying
> > > we have documentation up on
> > > http://lucenenet.apache.org/docs/3.0.3/Index.html and
> > > http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of these
> > > links
> > > are broken.  How can we get the 3.0.3 documentation in those places?
> > >
> > >
> > > Thanks,
> > > Christopher
> > >
> >
>

Re: 3.0.3 release documentation

Posted by Andy Pook <an...@gmail.com>.
Nice.
One tiny bug. I think "Index.html" should probably have a lower case i.
Currently the link to "Main Page" doesn't work (ie 404).

Cheers


On 9 January 2013 01:24, Troy Howard <th...@gmail.com> wrote:

> I went ahead and built docs using doxygen for the 3.0.3 release and pushed
> those changed to the public site. The referenced link
> http://lucenenet.apache.org/docs/3.0.3/Index.html works now.
>
> I didn't build a CHM because I'm using a Mac, and couldn't find anything
> open source/*NIX friendly to build a CHM from that. Now that the HTML docs
> are built, making a CHM of them should be pretty easy, if you're on
> Windows. I can try to do that in the next day or two if I can find my way
> to a Windows machine.
>
> Thanks,
> Troy
>
>
>
> On Mon, Dec 31, 2012 at 12:01 PM, Christopher Currens <
> currens.chris@gmail.com> wrote:
>
> > I was looking at the readme.txt file on our GItHub mirror, and it's
> saying
> > we have documentation up on
> > http://lucenenet.apache.org/docs/3.0.3/Index.html and
> > http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm.  Both of these
> > links
> > are broken.  How can we get the 3.0.3 documentation in those places?
> >
> >
> > Thanks,
> > Christopher
> >
>