Hello Guys, I was working over the weekend on getting updated installers which solved several issues reported at RubyForge and GitHub issues: http://github.com/oneclick/rubyinstaller/blob/master/History.txt As the TODO list stands today: http://gist.github.com/151832 I have one last thing to add: Signed installers. I''m getting a software certificate to authenticate our installers. Should be the upcoming days. Now, we need to determine the steps for the documentation.>From the last things that we discussed, Gordon''s work is going toprovide a suitable CHM file for us to rejoice. We still want RI docs? Perhaps we can add some note to the installer? I''m with the idea of promoting it, but if RI is a must, want to hear what you guys think (last time, I promise). Thank you and keep you on the loop! :-D -- Luis Lavena AREA 17 - Perfection in design is achieved not when there is nothing more to add, but rather when there is nothing more to take away. Antoine de Saint-Exup?ry
> I was working over the weekend on getting updated installers which > solved several issues reported at RubyForge and GitHub issues: > > http://github.com/oneclick/rubyinstaller/blob/master/History.txtNice!> As the TODO list stands today: > > http://gist.github.com/151832Thanks for keeping it updated. It allows us to keep up to date and chime in when we have some time and ask you what specifically needs done for items on the list. One note, please ensure you break down the tasks into relevant "micro-tasks" so that someone who has about ~1hr or so to contribute can help without needing too take on too big of a bite-o-work. This is one of the themes I think is so important for projects....courting the "micro-contributor" who wants to help out but only has limited amounts of time. We need to make it easy for people to come and go while still adding value. More on this later...> Now, we need to determine the steps for the documentation. > > >From the last things that we discussed, Gordon''s work is going to > provide a suitable CHM file for us to rejoice. > > We still want RI docs? Perhaps we can add some note to the installer? > > I''m with the idea of promoting it, but if RI is a must, want to hear > what you guys think (last time, I promise).With Gordon''s work I''m now for *completely* omitting the RI files combined with the following: 1) [MUST HAVE] notification in the install process that RI information is contained in the CHM files. Make sure this notification is also prominent in any README installed. 2) [NICE TO HAVE] quick hook in ri command to print out a header that reminds a user to check the CHM files. This would be a Monkey Patch specific to OCI I know, but is useful for the case in which RI info is generated for installed RubyGems. We need to get closure on this one and move on. I''m strongly advocating *not* including the RI info. If we find out later this was a stoopid decision that causes a lot of problem tickets, we can revisit. Chime in now.... OTHER OPEN DOCUMENTATION ISSUES ==============================1) what additional documentation, if any, should be installed as part of the documentation installer. My personal vote is just for as it appears to be more maintained: The Book of Ruby, 2.9MB: http://www.sapphiresteel.com/The-Book-Of-Ruby 2) What are the final links to be created by the installer? For example... http://allgems.ruby-forum.com/ others?
On Tue, Aug 4, 2009 at 12:36 PM, Jon<jon.forums at gmail.com> wrote:> >> As the TODO list stands today: >> >> http://gist.github.com/151832 > > [...] > > One note, please ensure you break down the tasks into relevant "micro-tasks" so that someone who has about ~1hr or so to contribute can help without needing too take on too big of a bite-o-work. >I thought I did slice those to small pieces. For example, testing the installers could be considered a micro-task. Adding the History file to the installer, while it requires some InnoSetup knowledge, should be pretty straight forward (using InnoSetup and ISTool as GUI editing tool.> > With Gordon''s work I''m now for *completely* omitting the RI files combined with the following: > > 1) [MUST HAVE] notification in the install process that RI information is contained in the CHM files. ?Make sure this notification is also prominent in any README installed. >That is then candidate for a better README.txt, adding that to the TODO. The README content will be added to the installer and a shortcut will be displayed in the Start Menu.> 2) [NICE TO HAVE] quick hook in ri command to print out a header that reminds a user to check the CHM files. ?This would be a Monkey Patch specific to OCI I know, but is useful for the case in which RI info is generated for installed RubyGems. >Unless someone patch and stub ri command, I believe that is not going to happen right now, Adding this to the TODO for volunteers to take over.> We need to get closure on this one and move on. ?I''m strongly advocating *not* including the RI info. ?If we find out later this was a stoopid decision that causes a lot of problem tickets, we can revisit. >Me too. So: no separate installers for the CHM, those will be bundled in the installer. Gordon: would you mind send me a pull request when your fork is acceptable to integrate the CHM into the installer?> OTHER OPEN DOCUMENTATION ISSUES > ==============================> 1) what additional documentation, if any, should be installed as part of the documentation installer. > > My personal vote is just for as it appears to be more maintained: > > The Book of Ruby, 2.9MB: > http://www.sapphiresteel.com/The-Book-Of-Ruby >We need to request permission for doing it, added to the TODO list and assigned to you.> 2) What are the final links to be created by the installer? ?For example... > > http://allgems.ruby-forum.com/ > others? >Right now, you can find that here: http://github.com/oneclick/rubyinstaller/blob/master/resources/installer/rubyinstaller.iss#L73-76 All those point to ruby-doc, since current installer used as reference. There is one 1.8 and 1.9 specific, which is Core API, that can be found inside config-1.8 and config-1.9 Anyone thinking on better links? Send your requests. Even better: open a ticket on GitHub issues, then we are going to vote which is going to be better for it. That''s all for now I believe. -- Luis Lavena AREA 17 - Perfection in design is achieved not when there is nothing more to add, but rather when there is nothing more to take away. Antoine de Saint-Exup?ry
> We need to get closure on this one and move on. ?I''m strongly advocating *not* including the RI info. ?If we find out later this was a stoopid decision that causes a lot of problem tickets, we can revisit. > > Chime in now....Perhaps the CHM''s can go in the main installer and the ri''s in another? Or maybe I could work on an ri generator gem, i.e. $ gem install ri_generator $ ri_generate_core # downloads core, runs rdoc against it, installs the ri for you locally Then we would never have to worry about installing ri--the end user can easily recreate the RI on the fly :) Thoughts?> > 2) What are the final links to be created by the installer? ?For example... > > http://allgems.ruby-forum.com/+1 for that one [oh wait, I made it so I''m biased]. Thanks. -r
> Perhaps the CHM''s can go in the main installer and the ri''s in another? > Or maybe I could work on an ri generator gem, i.e. > $ gem install ri_generator > $ ri_generate_core # downloads core, runs rdoc against it, installs > the ri for you locally > > Then we would never have to worry about installing ri--the end user > can easily recreate the RI on the fly :) > > Thoughts?Another option would be to somehow make an ri that can link into a remote ri, so you don''t have to install things locally [ex: link in to webri.tigerops.org]. I might blend that into my method describer gem[1] soon. [1] http://github.com/rogerdpack/method_describer/tree/master -r
On Sat, Aug 8, 2009 at 10:35 AM, Roger Pack<rogerdpack at gmail.com> wrote:>> We need to get closure on this one and move on. ?I''m strongly advocating *not* including the RI info. ?If we find out later this was a stoopid decision that causes a lot of problem tickets, we can revisit. >> >> Chime in now.... > > Perhaps the CHM''s can go in the main installer and the ri''s in another?The CHM will be in the installer, no separate one.> Or maybe I could work on an ri generator gem, i.e. > $ gem install ri_generator > $ ri_generate_core # downloads core, runs rdoc against it, installs > the ri for you locally > > Then we would never have to worry about installing ri--the end user > can easily recreate the RI on the fly :) > > Thoughts? >Be my guess and hack it :-D>> 2) What are the final links to be created by the installer? ?For example... >> >> http://allgems.ruby-forum.com/ > > +1 for that one [oh wait, I made it so I''m biased].Sorry to ask, what would be the purpose of that particular link, and what would be the title you would put to the shortcut? Try to explain it in one sentence, since the shortcut and the tooltip help are only one liners. Cheers, -- Luis Lavena AREA 17 - Perfection in design is achieved not when there is nothing more to add, but rather when there is nothing more to take away. Antoine de Saint-Exup?ry