Kevin et al., Many thanks for taking a look at this, it is certainly true that the documentation is lacking in many areas. I haven't been able to look at the work you've done, as none of the mail I have seen have any attachments (it's possible that the SourceForge mail ing list strip zip files?)
Whilst I am not going to try to stop any activity in this area, I have some observations that you may choose to guide your activities: (1) My supply of tuits is very small, so I doubt that I will contribute much. (2) I am happy to give a commit bit to anyone who wants to commit changes to the core source code. (3) For the core documentation (i.e. functional documentation of the classes/methods within the Win32::GUI distribution) I'd like to see the docs reside within the source repository and be distributed with Win32::GUI. Fundamentally this means writing POD (which gets converted to HTML during the build process) or embedded docs as we currently have, with a suitable toolset for pulling the embedded docs into pod during the build[1]. An investigation into what other larger projects do might be worthwhile. (4) For other documentation (Tutorials etc) I am less concerned that they are kept in the core source, but would propose that they be hosted somewhere related to the project - as a first suggestion I'd be happy to give someone enough permissions to have a play with the hosted apps that SourceForge now offer (which weren't available last time I looked). There's certainly wiki and other documentation tools available there. Of course, it may be that none of the offered solutions suit us. (5) For experience, if we don't find a way to merge your changes in to the core documentation, or host them somewhere where someone else can take over maintenance, then they will drop into disuse over time. It is my experience that the closer you can put the documentation to the code it is documenting, the more likely that it will be kept up to date. Finally, I am also seeking someone who would be happy to take over the maintenance of the Win32::GUI website - it could do with a re-vamp and some TLC. Any takers? This work might tie in nicely with moving us over to a new Wiki (or similar). Thanks for all the interest. Rob. [1] It would actually be better to have the embedded docs pulled into POD before the build, so that source distributions to CPAN get their POD displayed properly. 2009/7/14 Glenn Linderman <p...@nevcal.com>: > On approximately 7/13/2009 12:51 AM, came the following characters from > the keyboard of Reini Urban: >> 2009/7/13 Glenn Linderman <p...@nevcal.com>: >> >>> So at the present time, I'm not sure >>> 1) if there are any active developers >>> 2) if there are any that would agree that moving the documentation to >>> separate files would be a good thing >>> 3) who would apply your documentation patches to the repository, even if >>> you submitted them that way, rather than creating your own web site >>> >>> I don't remember if Reini has a commit bit or not, >>> >> >> No, I don't think I have a commit bit. >> >> >>> but I don't think he's ever built a release. >>> >> >> No, I'm doing all the cygwin releases since years. >> > > That's right! I knew you were involved somehow, but couldn't remember > how. Of course building the cygwin package, is taking a release, and > building and packaging it. Really, building a release is likely simple, > although likely changed since I last did it, in the sense of the file > manipulations required, but the hard part comes in doing sufficient > testing to be convinced that it is a good release. And there are more > parts now than last I did it. I worked only on very focused bug fixes, > even then. > >>> There have been significant changes to >>> sourceforge in the intervening period, as well, so it would take some >>> learning curve for me (and probably for Reini, although maybe he's up on >>> the sourceforge changes from other projects) to attempt to build a >>> release, methinks. Or maybe Rob will poke his head in here, and say >>> that he could find some time to commit some doc changes and build a new >>> release... >>> >> >> I maintain phpwiki on sf.net and it gets worse and worse. >> > > Could you elaborate? I'm not sure what this is. > >> But posting releases is still simple. >> > > That sounds good. > > ------------------------------------------------------------------------------ > Enter the BlackBerry Developer Challenge > This is your chance to win up to $100,000 in prizes! For a limited time, > vendors submitting new applications to BlackBerry App World(TM) will have > the opportunity to enter the BlackBerry Developer Challenge. See full prize > details at: http://p.sf.net/sfu/Challenge > _______________________________________________ > Perl-Win32-GUI-Users mailing list > Perl-Win32-GUI-Users@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/perl-win32-gui-users > http://perl-win32-gui.sourceforge.net/ > ------------------------------------------------------------------------------ Enter the BlackBerry Developer Challenge This is your chance to win up to $100,000 in prizes! For a limited time, vendors submitting new applications to BlackBerry App World(TM) will have the opportunity to enter the BlackBerry Developer Challenge. See full prize details at: http://p.sf.net/sfu/Challenge _______________________________________________ Perl-Win32-GUI-Users mailing list Perl-Win32-GUI-Users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/perl-win32-gui-users http://perl-win32-gui.sourceforge.net/
