A forum for documentation standards and tools for the Ruby programming language.

Gavin Sinclair | 12 Dec 2003 08:25

Re: stdlib docs suggestion

On Friday, December 12, 2003, 5:46:47 PM, Dmitry wrote:

> Hi,
> I was lurking for some time here, so I'm sure you don't know me :)
> I have one suggestion for stdlib docs. At that page: 
> http://www.ruby-doc.org/stdlib/introduction.html
> In section "Downloading and Installing" it would be nice to have
> link to a http://www.ruby-doc.org/stdlib/download.html page at the
> beginning.

OK.

> I spent 10 minutes while trying to find where can I download
> a tar.ball, maybe that's just me so stupid, but anyway I don't think that
> this link will be misplaced.

The thought had occured to me to put a link in there, so I might as
well cater for people who have just woken up :)

> Also, there is a rubyforge entry for stdlib, but no file releases made,
> would be cool to have them there too(like mirror or so). And also
> there will be more places where one could find stdlib.

How important/beneficial do you think this is?  James and I have a
good process going where I can run 'rake upload', which generates,
tars, zips, and FTPs.  An hour later, the new documentation *and* the
new download file appear on ruby-doc.  I don't want to manually
release files on RubyForge as well.  Rake either has now or may have
soon a task for releasing files on RubyForge, so the manual part may
disappear.  But still I wonder of the benefit.

(Continue reading)

headers

Dmitry V. Sabanin | 12 Dec 2003 09:35

Re: stdlib docs suggestion

On Friday 12 December 2003 14:25, Gavin Sinclair wrote:
> On Friday, December 12, 2003, 5:46:47 PM, Dmitry wrote:
8-<
> > I spent 10 minutes while trying to find where can I download
> > a tar.ball, maybe that's just me so stupid, but anyway I don't think that
> > this link will be misplaced.
>
> The thought had occured to me to put a link in there, so I might as
> well cater for people who have just woken up :)
Thank you for understanding 

> > Also, there is a rubyforge entry for stdlib, but no file releases made,
> > would be cool to have them there too(like mirror or so). And also
> > there will be more places where one could find stdlib.
>
> How important/beneficial do you think this is?  James and I have a
> good process going where I can run 'rake upload', which generates,
> tars, zips, and FTPs.  An hour later, the new documentation *and* the
> new download file appear on ruby-doc.  I don't want to manually
> release files on RubyForge as well.  Rake either has now or may have
> soon a task for releasing files on RubyForge, so the manual part may
> disappear.  But still I wonder of the benefit.
>
> I've just had an idea.  When you get this email, or 15 minutes later,
> check the releases at rubyforge.org/projects/stdlib-doc :)
The way you did that is quite nice. I didn't know about 'rake upload', that's why
I proposed adding files to rubyforge.

Thank you for a quick response, Gavin! I think that job you and others do
documenting ruby is very important for whole community. Keep it up! :)

(Continue reading)

headers

Gavin Sinclair | 12 Dec 2003 14:11

Re: stdlib docs suggestion

On Friday, December 12, 2003, 7:35:53 PM, Dmitry wrote:

> On Friday 12 December 2003 14:25, Gavin Sinclair wrote:
>> On Friday, December 12, 2003, 5:46:47 PM, Dmitry wrote:
> 8-<
>> > I spent 10 minutes while trying to find where can I download
>> > a tar.ball, maybe that's just me so stupid, but anyway I don't think that
>> > this link will be misplaced.
>>
>> The thought had occured to me to put a link in there, so I might as
>> well cater for people who have just woken up :)
> Thank you for understanding 

No worries, I know how it feels :)

>> I've just had an idea.  When you get this email, or 15 minutes later,
>> check the releases at rubyforge.org/projects/stdlib-doc :)
> The way you did that is quite nice. I didn't know about 'rake upload', that's why
> I proposed adding files to rubyforge.

It's not a built-in.  My hand-coded "upload" task uses Net::FTP to
upload the files.  The task has a dependency on :package (which builds
the archive files), which in turn depends on "gendoc", which generates
the documentation!  Rake was a great investment of time.  My Rakefile
also generates the RDoc for the stdlib-doc source code and uploads it
to RubyForge.  Too easy.

> Thank you for a quick response, Gavin! I think that job you and others do
> documenting ruby is very important for whole community. Keep it up! :)

(Continue reading)

headers

Dmitry V. Sabanin | 13 Dec 2003 10:06

Re: stdlib docs suggestion

On Friday 12 December 2003 20:11, Gavin Sinclair wrote:
> > On Friday 12 December 2003 14:25, Gavin Sinclair wrote:
> It's not a built-in.  My hand-coded "upload" task uses Net::FTP to
> upload the files.  The task has a dependency on :package (which builds
> the archive files), which in turn depends on "gendoc", which generates
> the documentation!  Rake was a great investment of time.  My Rakefile
> also generates the RDoc for the stdlib-doc source code and uploads it
> to RubyForge.  Too easy.
Wow, that's nice! I guess I need to learn about Rake too, always had problems
understanding make ^-)

> > P.S. sorry for my english :)
>
> I didn't notice anything to apologise for :)
Nevermind then, that's my paranoia :)

--

-- 
sdmitry -=- Dmitry V. Sabanin
MuraveyLabs.
Spam Here -> postmaster <at> sco.com