RE: Apache Manual (was ApacheForge)
Title: RE: Apache Manual (was ApacheForge) Done. It might go in jakarta-site2/site. I added a short introduction, that should be replaced by someone more knowledgeable. Un saludo, Alex. -Mensaje original- De: Jon Scott Stevens [mailto:[EMAIL PROTECTED]] Enviado el: jueves 21 de febrero de 2002 20:28 Para: [EMAIL PROTECTED] Asunto: Re: Apache Manual (was ApacheForge) on 2/21/02 4:31 AM, Fernandez Martinez, Alejandro [EMAIL PROTECTED] wrote: Now, including the valuable contributions of Marc and Jon, the annotated Apache manual TOC would look like this. Now, format it as an xdoc .xml file @see http://jakarta.apache.org/site/jakarta-site2.html and lets run with that... :-) -jon -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED] methodology.xml Description: Binary data -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
RE: Apache Manual (was ApacheForge)
Actually, there is searching. See the Search Apache Sites link at: http://jakarta.apache.org/ Maybe we need a nice textbox for searching at every page! (Hey, don't look at mee!) Have fun, Paulo -Original Message- From: James Strachan [mailto:[EMAIL PROTECTED]] Sent: Friday, February 22, 2002 1:35 AM To: Jakarta General List Subject: Re: Apache Manual (was ApacheForge) I think one thing this conversation seems to have highlighted is that there's plenty of good documentation all over the apache sites, we could just do with some more sitemap / indexing / searching features to be able to find stuff. (quickly ducking before people think I'm volunteering). James - Original Message - From: Fernandez Martinez, Alejandro [EMAIL PROTECTED] To: 'Jakarta General List' [EMAIL PROTECTED] Sent: Thursday, February 21, 2002 12:31 PM Subject: RE: Apache Manual (was ApacheForge) Ok, thanks a lot, Marc and Jon. Included are some links from xml.apache.org, luckily they resemble Jakarta's documents a lot. I know nothing about other Apache projects; I started adding links from httpd.apache.org like crazy, but then realized that the TOC was losing focus exponentially. Probably, someone else should tackle this problem. Now, including the valuable contributions of Marc and Jon, the annotated Apache manual TOC would look like this. 1.- Introduction Who we are, why are we doing this. http://jakarta.apache.org/site/whoweare.html http://xml.apache.org/whoweare.html http://httpd.apache.org/ABOUT_APACHE.html 2.- Project proposal Proposal stage, committers needed, community. http://jakarta.apache.org/site/getinvolved.html http://jakarta.apache.org/site/newproject.html 3.- Apache rules Who gets to vote what. Voting rules, valid votes, +1/+0/0/-0/-1. http://jakarta.apache.org/site/roles.html http://jakarta.apache.org/site/decisions.html http://xml.apache.org/roles.html http://xml.apache.org/decisions.html http://cvs.apache.org/viewcvs.cgi/xml-admin/charter.txt 4.- Code organization and repositories Naming of packages, repositories, what to find in them. Who touches what. http://jakarta.apache.org/site/dirlayout.html http://jakarta.apache.org/site/guidelines.html http://jakarta.apache.org/site/agreement.html 5.- Code quality Add copyright notice, add authors. Format your code but not others'. http://jakarta.apache.org/site/agreement.html http://xml.apache.org/source.html 6.- Testing Adding test cases. Solving bugs, errors, showstoppers. Security problems. http://httpd.apache.org/security_report.html 7.- Build system Use Ant, use Ant, use Ant. Use Gump. Use Scarab. Not done yet. 8.- Dependencies What jar's to use and what to avoid. http://jakarta.apache.org/site/jars.html 9.- Documentation Where to look for it. What to expect, what not to expect. Not done yet. 10.- Releases When to release, what to release. Release process. http://jakarta.apache.org/site/binindex.html 11.- Support Whom you should ask, what you should figure out yourself. http://jakarta.apache.org/site/mail.html http://xml.apache.org/mail.html 12.- Licensing and guarantee Why you should use Apache license, and what's wrong with other licenses. What you can do with Apache products. Giving credit. All that implied warranty things. http://www.apache.org/foundation/licence-FAQ.html http://xml.apache.org/dist/LICENSE.txt -Mensaje original- De: Marc Saegesser [mailto:[EMAIL PROTECTED]] Enviado el: miércoles 20 de febrero de 2002 20:19 Para: Jakarta General List Asunto: RE: Apache Manual (was ApacheForge) Alex, That's a really good start. My only comment right now is to point out that some of the topics in this list are Jakarta specific and Apache is much bigger than Jakarta. It would be cool if a manual such as this covered how other Apache projects handle similar tasks. I'd also include a chapter on Apache and Jakarta rules. For example, voting rules, what constitutes a valid vote, what are the voting types and when they apply, what are meanings of +1/+0/0/-0/-1 in the various voting types. A collection of release instructions for various projects might also be useful. When I was the release manager for Tomcat 3.2.x I got some initial help from Craig, but after that I had to invent most of the process myself (and I'll be the first admit that I didn't document that process :-( ). I'm sure I think of more after giving it some more thought. Good start, though. Marc Saegesser -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED] -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
RE: Apache Manual (was ApacheForge)
Ok, thanks a lot, Marc and Jon. Included are some links from xml.apache.org, luckily they resemble Jakarta's documents a lot. I know nothing about other Apache projects; I started adding links from httpd.apache.org like crazy, but then realized that the TOC was losing focus exponentially. Probably, someone else should tackle this problem. Now, including the valuable contributions of Marc and Jon, the annotated Apache manual TOC would look like this. 1.- Introduction Who we are, why are we doing this. http://jakarta.apache.org/site/whoweare.html http://xml.apache.org/whoweare.html http://httpd.apache.org/ABOUT_APACHE.html 2.- Project proposal Proposal stage, committers needed, community. http://jakarta.apache.org/site/getinvolved.html http://jakarta.apache.org/site/newproject.html 3.- Apache rules Who gets to vote what. Voting rules, valid votes, +1/+0/0/-0/-1. http://jakarta.apache.org/site/roles.html http://jakarta.apache.org/site/decisions.html http://xml.apache.org/roles.html http://xml.apache.org/decisions.html http://cvs.apache.org/viewcvs.cgi/xml-admin/charter.txt 4.- Code organization and repositories Naming of packages, repositories, what to find in them. Who touches what. http://jakarta.apache.org/site/dirlayout.html http://jakarta.apache.org/site/guidelines.html http://jakarta.apache.org/site/agreement.html 5.- Code quality Add copyright notice, add authors. Format your code but not others'. http://jakarta.apache.org/site/agreement.html http://xml.apache.org/source.html 6.- Testing Adding test cases. Solving bugs, errors, showstoppers. Security problems. http://httpd.apache.org/security_report.html 7.- Build system Use Ant, use Ant, use Ant. Use Gump. Use Scarab. Not done yet. 8.- Dependencies What jar's to use and what to avoid. http://jakarta.apache.org/site/jars.html 9.- Documentation Where to look for it. What to expect, what not to expect. Not done yet. 10.- Releases When to release, what to release. Release process. http://jakarta.apache.org/site/binindex.html 11.- Support Whom you should ask, what you should figure out yourself. http://jakarta.apache.org/site/mail.html http://xml.apache.org/mail.html 12.- Licensing and guarantee Why you should use Apache license, and what's wrong with other licenses. What you can do with Apache products. Giving credit. All that implied warranty things. http://www.apache.org/foundation/licence-FAQ.html http://xml.apache.org/dist/LICENSE.txt -Mensaje original- De: Marc Saegesser [mailto:[EMAIL PROTECTED]] Enviado el: miércoles 20 de febrero de 2002 20:19 Para: Jakarta General List Asunto: RE: Apache Manual (was ApacheForge) Alex, That's a really good start. My only comment right now is to point out that some of the topics in this list are Jakarta specific and Apache is much bigger than Jakarta. It would be cool if a manual such as this covered how other Apache projects handle similar tasks. I'd also include a chapter on Apache and Jakarta rules. For example, voting rules, what constitutes a valid vote, what are the voting types and when they apply, what are meanings of +1/+0/0/-0/-1 in the various voting types. A collection of release instructions for various projects might also be useful. When I was the release manager for Tomcat 3.2.x I got some initial help from Craig, but after that I had to invent most of the process myself (and I'll be the first admit that I didn't document that process :-( ). I'm sure I think of more after giving it some more thought. Good start, though. Marc Saegesser
Re: Apache Manual (was ApacheForge)
on 2/21/02 4:31 AM, Fernandez Martinez, Alejandro [EMAIL PROTECTED] wrote: Now, including the valuable contributions of Marc and Jon, the annotated Apache manual TOC would look like this. Now, format it as an xdoc .xml file @see http://jakarta.apache.org/site/jakarta-site2.html and lets run with that... :-) -jon -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
Re: Apache Manual (was ApacheForge)
I think one thing this conversation seems to have highlighted is that there's plenty of good documentation all over the apache sites, we could just do with some more sitemap / indexing / searching features to be able to find stuff. (quickly ducking before people think I'm volunteering). James - Original Message - From: Fernandez Martinez, Alejandro [EMAIL PROTECTED] To: 'Jakarta General List' [EMAIL PROTECTED] Sent: Thursday, February 21, 2002 12:31 PM Subject: RE: Apache Manual (was ApacheForge) Ok, thanks a lot, Marc and Jon. Included are some links from xml.apache.org, luckily they resemble Jakarta's documents a lot. I know nothing about other Apache projects; I started adding links from httpd.apache.org like crazy, but then realized that the TOC was losing focus exponentially. Probably, someone else should tackle this problem. Now, including the valuable contributions of Marc and Jon, the annotated Apache manual TOC would look like this. 1.- Introduction Who we are, why are we doing this. http://jakarta.apache.org/site/whoweare.html http://xml.apache.org/whoweare.html http://httpd.apache.org/ABOUT_APACHE.html 2.- Project proposal Proposal stage, committers needed, community. http://jakarta.apache.org/site/getinvolved.html http://jakarta.apache.org/site/newproject.html 3.- Apache rules Who gets to vote what. Voting rules, valid votes, +1/+0/0/-0/-1. http://jakarta.apache.org/site/roles.html http://jakarta.apache.org/site/decisions.html http://xml.apache.org/roles.html http://xml.apache.org/decisions.html http://cvs.apache.org/viewcvs.cgi/xml-admin/charter.txt 4.- Code organization and repositories Naming of packages, repositories, what to find in them. Who touches what. http://jakarta.apache.org/site/dirlayout.html http://jakarta.apache.org/site/guidelines.html http://jakarta.apache.org/site/agreement.html 5.- Code quality Add copyright notice, add authors. Format your code but not others'. http://jakarta.apache.org/site/agreement.html http://xml.apache.org/source.html 6.- Testing Adding test cases. Solving bugs, errors, showstoppers. Security problems. http://httpd.apache.org/security_report.html 7.- Build system Use Ant, use Ant, use Ant. Use Gump. Use Scarab. Not done yet. 8.- Dependencies What jar's to use and what to avoid. http://jakarta.apache.org/site/jars.html 9.- Documentation Where to look for it. What to expect, what not to expect. Not done yet. 10.- Releases When to release, what to release. Release process. http://jakarta.apache.org/site/binindex.html 11.- Support Whom you should ask, what you should figure out yourself. http://jakarta.apache.org/site/mail.html http://xml.apache.org/mail.html 12.- Licensing and guarantee Why you should use Apache license, and what's wrong with other licenses. What you can do with Apache products. Giving credit. All that implied warranty things. http://www.apache.org/foundation/licence-FAQ.html http://xml.apache.org/dist/LICENSE.txt -Mensaje original- De: Marc Saegesser [mailto:[EMAIL PROTECTED]] Enviado el: miércoles 20 de febrero de 2002 20:19 Para: Jakarta General List Asunto: RE: Apache Manual (was ApacheForge) Alex, That's a really good start. My only comment right now is to point out that some of the topics in this list are Jakarta specific and Apache is much bigger than Jakarta. It would be cool if a manual such as this covered how other Apache projects handle similar tasks. I'd also include a chapter on Apache and Jakarta rules. For example, voting rules, what constitutes a valid vote, what are the voting types and when they apply, what are meanings of +1/+0/0/-0/-1 in the various voting types. A collection of release instructions for various projects might also be useful. When I was the release manager for Tomcat 3.2.x I got some initial help from Craig, but after that I had to invent most of the process myself (and I'll be the first admit that I didn't document that process :-( ). I'm sure I think of more after giving it some more thought. Good start, though. Marc Saegesser -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
RE: Apache Manual (was ApacheForge)
Why not start it yourself and anyone can suggest changes. On the other hand, why not start it myself. Something like this: 1.- Introduction Who we are, why are we doing this. 2.- Project proposal Proposal stage, committers needed, community. 3.- Code organization and repositories Naming of packages, repositories, what to find in them. Who touches what. 4.- Code quality Add copyright notice, add authors. Format your code but not others'. 4.- Build system Use Ant, use Ant, use Ant. Use Gump. Use Scarab. 5.- Dependencies What jar's to use and what to avoid. 6.- Documentation Where to look for it. What to expect, what not to expect. 7.- Support Whom you should ask, what you should figure out yourself. 8.- Licensing and guarantee Why you should use Apache license, and what's wrong with other licenses. What you can do with Apache products. Giving credit. All that implied warranty things. Un saludo, Alex. -Mensaje original- De: Paul Hammant [mailto:[EMAIL PROTECTED]] Enviado el: miércoles 20 de febrero de 2002 18:51 Para: Jakarta General List Asunto: Apache Manual (was ApacheForge) Jon, Give us a TOC for what you think might be a good starting point. That said, I will do my best to support someone who wants to create a manual like that. If you hang around here and watch what happens and how people do things and start to document it. Then I promise to review it and comment on it. - Paul -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
Re: Apache Manual (was ApacheForge)
I don't think you understood what I said...so let me repeat... You give me a TOC and I will review and comment on it. :-) -jon on 2/20/02 9:50 AM, Paul Hammant [EMAIL PROTECTED] wrote: Jon, Give us a TOC for what you think might be a good starting point. That said, I will do my best to support someone who wants to create a manual like that. If you hang around here and watch what happens and how people do things and start to document it. Then I promise to review it and comment on it. - Paul -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
Re: Apache Manual (was ApacheForge)
on 2/20/02 10:03 AM, Fernandez Martinez, Alejandro [EMAIL PROTECTED] wrote: Why not start it yourself and anyone can suggest changes. I love it when people 'get it'. :-) On the other hand, why not start it myself. Something like this: You kick ass. Note that the majority of your bullet points are already in some form of documentation on the website that no one bothers to read. 1.- Introduction Who we are, why are we doing this. http://jakarta.apache.org/site/whoweare.html 2.- Project proposal Proposal stage, committers needed, community. http://jakarta.apache.org/site/getinvolved.html http://jakarta.apache.org/site/newproject.html 3.- Code organization and repositories Naming of packages, repositories, what to find in them. Who touches what. http://jakarta.apache.org/site/guidelines.html 4.- Code quality Add copyright notice, add authors. Format your code but not others'. http://jakarta.apache.org/site/dirlayout.html http://jakarta.apache.org/site/agreement.html 4.- Build system Use Ant, use Ant, use Ant. Use Gump. Use Scarab. Not done yet. 5.- Dependencies What jar's to use and what to avoid. http://jakarta.apache.org/site/jars.html 6.- Documentation Where to look for it. What to expect, what not to expect. Not done yet. 7.- Support Whom you should ask, what you should figure out yourself. http://jakarta.apache.org/site/mail.html 8.- Licensing and guarantee Why you should use Apache license, and what's wrong with other licenses. What you can do with Apache products. Giving credit. All that implied warranty things. http://www.apache.org/foundation/licence-FAQ.html -jon -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
RE: Apache Manual (was ApacheForge)
Alex, That's a really good start. My only comment right now is to point out that some of the topics in this list are Jakarta specific and Apache is much bigger than Jakarta. It would be cool if a manual such as this covered how other Apache projects handle similar tasks. I'd also include a chapter on Apache and Jakarta rules. For example, voting rules, what constitutes a valid vote, what are the voting types and when they apply, what are meanings of +1/+0/0/-0/-1 in the various voting types. A collection of release instructions for various projects might also be useful. When I was the release manager for Tomcat 3.2.x I got some initial help from Craig, but after that I had to invent most of the process myself (and I'll be the first admit that I didn't document that process :-( ). I'm sure I think of more after giving it some more thought. Good start, though. Marc Saegesser -Original Message- From: Fernandez Martinez, Alejandro [mailto:[EMAIL PROTECTED]] Sent: Wednesday, February 20, 2002 12:04 PM To: 'Jakarta General List' Subject: RE: Apache Manual (was ApacheForge) Why not start it yourself and anyone can suggest changes. On the other hand, why not start it myself. Something like this: 1.- Introduction Who we are, why are we doing this. 2.- Project proposal Proposal stage, committers needed, community. 3.- Code organization and repositories Naming of packages, repositories, what to find in them. Who touches what. 4.- Code quality Add copyright notice, add authors. Format your code but not others'. 4.- Build system Use Ant, use Ant, use Ant. Use Gump. Use Scarab. 5.- Dependencies What jar's to use and what to avoid. 6.- Documentation Where to look for it. What to expect, what not to expect. 7.- Support Whom you should ask, what you should figure out yourself. 8.- Licensing and guarantee Why you should use Apache license, and what's wrong with other licenses. What you can do with Apache products. Giving credit. All that implied warranty things. Un saludo, Alex. -Mensaje original- De: Paul Hammant [mailto:[EMAIL PROTECTED]] Enviado el: miércoles 20 de febrero de 2002 18:51 Para: Jakarta General List Asunto: Apache Manual (was ApacheForge) Jon, Give us a TOC for what you think might be a good starting point. That said, I will do my best to support someone who wants to create a manual like that. If you hang around here and watch what happens and how people do things and start to document it. Then I promise to review it and comment on it. - Paul -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED] -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]