Re: Committing documentation
On Wed, Jul 28, 2004 at 01:24:22PM -0700, Clay Leeds wrote: > On Jul 28, 2004, at 11:51 AM, Simon Pepping wrote: > >On Sun, Jul 25, 2004 at 12:51:56PM -0700, Clay Leeds wrote: > >>As I understand it, you're primarily doing documentation that is more > >>developer and/or embedded oriented, which is one of the reasons why I > >>would want to have a new 'Documentation' tab. > > > >Indeed, it is. Does this mandate a specific directory to commit the > >files into? Or shall I create a directory in > >src/documentation/content/xdocs? Or in src/documentation/content/? > > > >Regards, Simon > > Good question. Actually, I was 'putting it out there(tm)' as to whether > or not other committers thought that was a good idea. Therefore, I'm > not sure where it should go *yet*. > > As for how it goes in, double-check the FAQ docbook section[1] (IIRC > you did the docs in docbook?). If you need more help, let me know. > > Web Maestro Clay > > [1] > http://forrest.apache.org/faq.html#docbook Thanks for the pointer. I have done what it requires, writing the documentation in Docbook XML 4.2. When the time is there, the map:match element should be added to the site map, and the docbook stylesheets should be reachable. I will commit the work to src/documentation/content/xdocs/DnI. That stands for 'Design and Implementation', into which I have changed the title. Regards, Simon -- Simon Pepping home page: http://www.leverkruid.nl
Re: Committing documentation
On Jul 28, 2004, at 11:51 AM, Simon Pepping wrote: On Sun, Jul 25, 2004 at 12:51:56PM -0700, Clay Leeds wrote: As I understand it, you're primarily doing documentation that is more developer and/or embedded oriented, which is one of the reasons why I would want to have a new 'Documentation' tab. Indeed, it is. Does this mandate a specific directory to commit the files into? Or shall I create a directory in src/documentation/content/xdocs? Or in src/documentation/content/? Regards, Simon Good question. Actually, I was 'putting it out there(tm)' as to whether or not other committers thought that was a good idea. Therefore, I'm not sure where it should go *yet*. As for how it goes in, double-check the FAQ docbook section[1] (IIRC you did the docs in docbook?). If you need more help, let me know. Web Maestro Clay [1] http://forrest.apache.org/faq.html#docbook
Re: Committing documentation
On Sun, Jul 25, 2004 at 12:51:56PM -0700, Clay Leeds wrote: > As I understand it, you're primarily doing documentation that is more > developer and/or embedded oriented, which is one of the reasons why I > would want to have a new 'Documentation' tab. Indeed, it is. Does this mandate a specific directory to commit the files into? Or shall I create a directory in src/documentation/content/xdocs? Or in src/documentation/content/? Regards, Simon -- Simon Pepping home page: http://www.leverkruid.nl
Re: (Copyright question) Re: Committing documentation
Simon, My past emails on this topic had a rude tone to it that I regret...I apologize for that. I just didn't know how things should be copyrighted once they're in the repository and just wanted to make sure we are doing things properly. Thanks for your work (especially since it's in Docbook ;) and I look forward to helping out in keeping it up-to-date. Glen --- Simon Pepping <[EMAIL PROTECTED]> wrote: > I completely agree with Christian's comment and > extract of the CLA. I > have signed it and thereby it applies to any work I > commit to FOP's > repository. That is my intention with the > documentation. > > I wrote 'copyright the Authors', with the idea that > every contributor > adds his name as an author. But that is indeed > probably not right. I > will change it to ASF. The files themselves already > have the Apache > License 2 text. > > Regards, Simon > > On Mon, Jul 26, 2004 at 04:16:18AM -0700, Glen Mazza > wrote: > > I believe the key word below is "transferable", > i.e., > > before checking any work in, it still needs to be > > copyright "The Apache Software Foundation" at the > time > > of it being cvs committed. Dirk-Willem, might you > > know more about this? (Original comments in [1] > > below.) > > > > But I noticed Simon already updated it to "The > > Authors"--all it needs to be next (I think) is ASF > and > > we're done: > > > http://www.leverkruid.nl/FOP/documentation-html/index.html > > > > We already have a dubious copyright notice in one > of > > our source files [2, lines 36-37], dubious because > the > > file has changed so many times by other people > over > > the years that it is unknown whether the copyright > > holder actually still "owns" any of the code. I'm > > inclined against adding non-ASF copyrighted work > to > > our repository, because once you have it there, it > is > > difficult to get rid of, no matter how out-of-date > > that copyright gets. If anyone is not ready to > > transfer the copyright to their work, then it > > shouldn't be in our repository. > > > > Glen > > > > [1] > > > http://marc.theaimsgroup.com/?l=fop-dev&m=109079517313375&w=2 > > > > [2] > > > http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/render/rtf/ListAttributesConverter.java?annotate=1.7 > > > > > > --- Christian Geisert > <[EMAIL PROTECTED]> > > wrote: > > > Glen Mazza wrote: > > > > Simon, a word of caution*, I believe that > anything > > > > that goes into the Apache repository will need > to > > > be > > > > copyright The Apache Software Foundation and > only > > > The > > > > Apache Software Foundation. (Just look at the > > > bottom > > > > > > No, the contribution is covered by the CLA > (which > > > you should have read > > > and signed too ;-) > > > > > > See http://www.apache.org/licenses/#clas, > paragraph > > > 2: > > > > > > You hereby grant to the Foundation a > > > non-exclusive, irrevocable, > > > worldwide, no-charge, transferable copyright > > > license to use, > > > execute, prepare derivative works of, and > > > distribute (internally > > > and externally, in object code and, if > included > > > in your > > > Contributions, source code form) your > > > Contributions. Except for the > > > rights granted to the Foundation in this > > > paragraph, You reserve all > > > right, title and interest in and to your > > > Contributions. > > > > > > > > > Christian > > > > > > > -- > Simon Pepping > home page: http://www.leverkruid.nl > >
Re: (Copyright question) Re: Committing documentation
I completely agree with Christian's comment and extract of the CLA. I have signed it and thereby it applies to any work I commit to FOP's repository. That is my intention with the documentation. I wrote 'copyright the Authors', with the idea that every contributor adds his name as an author. But that is indeed probably not right. I will change it to ASF. The files themselves already have the Apache License 2 text. Regards, Simon On Mon, Jul 26, 2004 at 04:16:18AM -0700, Glen Mazza wrote: > I believe the key word below is "transferable", i.e., > before checking any work in, it still needs to be > copyright "The Apache Software Foundation" at the time > of it being cvs committed. Dirk-Willem, might you > know more about this? (Original comments in [1] > below.) > > But I noticed Simon already updated it to "The > Authors"--all it needs to be next (I think) is ASF and > we're done: > http://www.leverkruid.nl/FOP/documentation-html/index.html > > We already have a dubious copyright notice in one of > our source files [2, lines 36-37], dubious because the > file has changed so many times by other people over > the years that it is unknown whether the copyright > holder actually still "owns" any of the code. I'm > inclined against adding non-ASF copyrighted work to > our repository, because once you have it there, it is > difficult to get rid of, no matter how out-of-date > that copyright gets. If anyone is not ready to > transfer the copyright to their work, then it > shouldn't be in our repository. > > Glen > > [1] > http://marc.theaimsgroup.com/?l=fop-dev&m=109079517313375&w=2 > > [2] > http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/render/rtf/ListAttributesConverter.java?annotate=1.7 > > > --- Christian Geisert <[EMAIL PROTECTED]> > wrote: > > Glen Mazza wrote: > > > Simon, a word of caution*, I believe that anything > > > that goes into the Apache repository will need to > > be > > > copyright The Apache Software Foundation and only > > The > > > Apache Software Foundation. (Just look at the > > bottom > > > > No, the contribution is covered by the CLA (which > > you should have read > > and signed too ;-) > > > > See http://www.apache.org/licenses/#clas, paragraph > > 2: > > > > You hereby grant to the Foundation a > > non-exclusive, irrevocable, > > worldwide, no-charge, transferable copyright > > license to use, > > execute, prepare derivative works of, and > > distribute (internally > > and externally, in object code and, if included > > in your > > Contributions, source code form) your > > Contributions. Except for the > > rights granted to the Foundation in this > > paragraph, You reserve all > > right, title and interest in and to your > > Contributions. > > > > > > Christian > > > -- Simon Pepping home page: http://www.leverkruid.nl
(Copyright question) Re: Committing documentation
I believe the key word below is "transferable", i.e., before checking any work in, it still needs to be copyright "The Apache Software Foundation" at the time of it being cvs committed. Dirk-Willem, might you know more about this? (Original comments in [1] below.) But I noticed Simon already updated it to "The Authors"--all it needs to be next (I think) is ASF and we're done: http://www.leverkruid.nl/FOP/documentation-html/index.html We already have a dubious copyright notice in one of our source files [2, lines 36-37], dubious because the file has changed so many times by other people over the years that it is unknown whether the copyright holder actually still "owns" any of the code. I'm inclined against adding non-ASF copyrighted work to our repository, because once you have it there, it is difficult to get rid of, no matter how out-of-date that copyright gets. If anyone is not ready to transfer the copyright to their work, then it shouldn't be in our repository. Glen [1] http://marc.theaimsgroup.com/?l=fop-dev&m=109079517313375&w=2 [2] http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/render/rtf/ListAttributesConverter.java?annotate=1.7 --- Christian Geisert <[EMAIL PROTECTED]> wrote: > Glen Mazza wrote: > > Simon, a word of caution*, I believe that anything > > that goes into the Apache repository will need to > be > > copyright The Apache Software Foundation and only > The > > Apache Software Foundation. (Just look at the > bottom > > No, the contribution is covered by the CLA (which > you should have read > and signed too ;-) > > See http://www.apache.org/licenses/#clas, paragraph > 2: > > You hereby grant to the Foundation a > non-exclusive, irrevocable, > worldwide, no-charge, transferable copyright > license to use, > execute, prepare derivative works of, and > distribute (internally > and externally, in object code and, if included > in your > Contributions, source code form) your > Contributions. Except for the > rights granted to the Foundation in this > paragraph, You reserve all > right, title and interest in and to your > Contributions. > > > Christian >
Re: Committing documentation
Glen Mazza wrote: Simon, a word of caution*, I believe that anything that goes into the Apache repository will need to be copyright The Apache Software Foundation and only The Apache Software Foundation. (Just look at the bottom No, the contribution is covered by the CLA (which you should have read and signed too ;-) See http://www.apache.org/licenses/#clas, paragraph 2: You hereby grant to the Foundation a non-exclusive, irrevocable, worldwide, no-charge, transferable copyright license to use, execute, prepare derivative works of, and distribute (internally and externally, in object code and, if included in your Contributions, source code form) your Contributions. Except for the rights granted to the Foundation in this paragraph, You reserve all right, title and interest in and to your Contributions. Christian
Re: Committing documentation
Simon, a word of caution*, I believe that anything that goes into the Apache repository will need to be copyright The Apache Software Foundation and only The Apache Software Foundation. (Just look at the bottom of any of the FOP site's web pages.) Else, best not to commit it--we can always add a link from the Fop site to the documentation on your home page. If you plan on expanding your writing in the future to other areas of XML document publishing, I would recommend the latter right now, as I wouldn't want you to lose your work. Glen *That Jeremias is most welcome to correct, should I be in error here. --- Simon Pepping <[EMAIL PROTECTED]> wrote: > I am preparing my documentation for check-in into > the repository. What > would be a suitable place. A directory in > src/documentation/content/xdocs? Would that be in > the way of the > forrest build of the web site? > > Regards, Simon > > -- > Simon Pepping > home page: http://www.leverkruid.nl > >
Re: Committing documentation
On Jul 25, 2004, at 11:43 AM, Simon Pepping wrote: I am preparing my documentation for check-in into the repository. What would be a suitable place. A directory in src/documentation/content/xdocs? Would that be in the way of the forrest build of the web site? Regards, Simon I've been thinking about that, and I think FOP needs to add a new 'Documentation' tab, like the structure for the Forrest[1] documentation[2]. I would probably move much of the content under "Using FOP" under this other tab (although we could still maintain links from the Home Page if desired, and use a similar navigation structure to what's currently in place). As I understand it, you're primarily doing documentation that is more developer and/or embedded oriented, which is one of the reasons why I would want to have a new 'Documentation' tab. Web Maestro Clay [1] http://forrest.apache.org/ [2] http://forrest.apache.org/docs/your-project.html
Committing documentation
I am preparing my documentation for check-in into the repository. What would be a suitable place. A directory in src/documentation/content/xdocs? Would that be in the way of the forrest build of the web site? Regards, Simon -- Simon Pepping home page: http://www.leverkruid.nl
