On 8/5/07, David Chisnall <[EMAIL PROTECTED]> wrote: > On 5 Aug 2007, at 18:22, Yen-Ju Chen wrote: > > > But I see no need to publish documentation > > when the API is under developement. > > The way I see documentation is just like making release of the > > tarball. > > So we only need to do so when preparing the next relelease > > by generating the documentation and uploading onto svn. > > Good point. If people want documentation from trunk it might make > more sense for them to build it themselves. > > > As for using download for documentation than svn, > > I feel it is weird to use "http://download.gna.org/etoile/"; for > > that. > > And that area is not easy to modify. You have to download the > > document, > > modify it, then upload again > > unless rsync can make it easier, which I don't know yet. > > Well, at least for framework documentation, I don't see that you > would ever do a download-modify-upload cycle. You'd modify the code, > containing autogsdoc comments and possibly the index.html template. > You then to make and have the docs come out, and then you'd scp/sftp/ > rsync them to the web site. Rsync acts just like scp in this case, > it just saves you from having to upload files that haven't changed. > You could use scp instead, however. The only thing to remember is > set the permissions correctly, and if we added a rule in etoile.make > to do this then you wouldn't need to remember. > > > That area also hosts the live CD, which are really big. > > I rather not to have a copy of all of them because I need to use > > rsync. > > Rsync is actually really badly named, because it only does > 'unidirection syncing' It doesn't copy files from the destination to > the source, it just makes sure that the files at the destination are > updated to match the ones at the source. The source would be the > documentation output directory, the destination would be > download.gna.org:/uploads/etoile/Documentation/$FRAMEWORK_NAME.
I was thinking that we put both API document for frameworks and user manual for applications at the same directory structure. So user manual for StepChat will be under Etoile/Services/User/Jabber and API document for TRXML will be under Etoile/Services/User/Jabber/TRXML. While API documentation is automatically generated, use manual are writtein by hand, which is not that easy to do with rsync and sftp, especially for collaboration as source code. Yen-Ju > > David > > _______________________________________________ > Etoile-discuss mailing list > [email protected] > https://mail.gna.org/listinfo/etoile-discuss > _______________________________________________ Etoile-discuss mailing list [email protected] https://mail.gna.org/listinfo/etoile-discuss
