Re: Clustering - initial overview doc... - where should we keep it ?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Jules Gosnell wrote: Guys, there seems to be some debate about whether the doc should end up in Confluence or MoinMoin... please resolve it and I will publish the doc. Official documentation for the project should be a) under source control in an ASF repository; b) hosted on Apache infrastructure; and c) easily exportable into a readable format that can be packaged for distribution with the code or separately. IMHO, wikis are good for prototyping and rapid collaboration. If a wiki is used, once consensus has been achieved, the content should be moved into the above environment. Working documentation *should* be on ASF infrastructure for holistic reasons and to be captured by the ASF backups. If the majority of the project wants to work in Confluence, then an instance of it should be installed at the ASF. This may require some of the proponents committing to support it there. Content in MoinMoin should be migrated to the Confluent environment. If the majority of the project wants to work in MoinMoin, the content in Confluence needs to be migrated into the Geronimo MoinMoin at Apache. Time for a vote, I guess.. - -- #kenP-)} Ken Coar, Sanagendamgagwedweinini http://Ken.Coar.Org/ Author, developer, opinionist http://Apache-Server.Com/ Millennium hand and shrimp! -BEGIN PGP SIGNATURE- Version: GnuPG v1.2.4 (MingW32) Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org iQCVAwUBQ9Dza5rNPMCpn3XdAQIFowP/eQ0SZO/waNyxe7ZNSxQSKdJRjivbNkmQ ut8rnvRIvqsnY3b/oMAb6G/bFSfFLh459apsrciCPoUEY0b5HmoR4RJNagItzH2J YwyhL8kBEiAzLVyvh1typf/wCEmEqzFdh7QyQoZdFL/SdsgGyUVaZrrSKOsaVS3J HLVQT5pcFnw= =ynzI -END PGP SIGNATURE-
Re: Clustering - initial overview doc... - where should we keep it ?
Guys, there seems to be some debate about whether the doc should end up in Confluence or MoinMoin... please resolve it and I will publish the doc. Jules Hernan Cunico wrote: Jules has the documentation for clustering and I am suggesting him to get that documentation published in confluence. Currently, there is just an empty entry in the Table of Contents pointing to *Clustering* in the *Performance and high availability* section. You can see the TOC here http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Cheers! Hernan lichtner wrote: So where is this document now? I am not very familiar with the web site there seems to be more than one place. On Wed, 18 Jan 2006, Hernan Cunico wrote: Hi Jules, many of the articles (if not all) started the same way and many of them are still a work in progress. It would be great if you can publish your doc there, I can give you a hand with the confluence formatting if you want to. Cheers! Hernan Jules Gosnell wrote: Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules -- Open Source is a self-assembling organism. You dangle a piece of string into a super-saturated solution and a whole operating-system crystallises out around it. /** * Jules Gosnell * Partner * Core Developers Network (Europe) * *www.coredevelopers.net * * Open Source Training Support. **/
Re: Clustering - initial overview doc... - where should we keep it ?
I'd say the Wiki if it's pretty open to being changed as we move forward (which would be my guess) or the geronimo/site SVN if it's permanent (as in, completely documents 1.0 and is not attempting to cover newer stuff). Aaron On 1/18/06, Jules Gosnell [EMAIL PROTECTED] wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules -- Open Source is a self-assembling organism. You dangle a piece of string into a super-saturated solution and a whole operating-system crystallises out around it. /** * Jules Gosnell * Partner * Core Developers Network (Europe) * *www.coredevelopers.net * * Open Source Training Support. **/
Re: Clustering - initial overview doc... - where should we keep it ?
Wiki might be a better idea for now so most people can contribute. However if it's under svn then non-comiiters can only contribute via patches. Another possiblity is to have it under the confluence thing that Hernan is working on. Also with wiki there want be issue about the format (wether it's text,html..etc) Whatever works best for the community. Regards, Rajith On 1/18/06, Aaron Mulder [EMAIL PROTECTED] wrote: I'd say the Wiki if it's pretty open to being changed as we moveforward (which would be my guess) or the geronimo/site SVN if it's permanent (as in, completely documents 1.0 and is not attempting tocover newer stuff).AaronOn 1/18/06, Jules Gosnell [EMAIL PROTECTED] wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules -- Open Source is a self-assembling organism. You dangle a piece of string into a super-saturated solution and a whole operating-system crystallises out around it. /*** Jules Gosnell* Partner* Core Developers Network (Europe)** www.coredevelopers.net** Open Source Training Support.**/
Re: Clustering - initial overview doc... - where should we keep it ?
Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules
Re: Clustering - initial overview doc... - where should we keep it ?
Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules -- Open Source is a self-assembling organism. You dangle a piece of string into a super-saturated solution and a whole operating-system crystallises out around it. /** * Jules Gosnell * Partner * Core Developers Network (Europe) * *www.coredevelopers.net * * Open Source Training Support. **/
Re: Clustering - initial overview doc... - where should we keep it ?
Can we resolve the Confluence vs. MoinMoin issue? Everything is currently in MoinMoin except the documentation that Hernan has been working on, is that right? If we're not committed to moving to confluence, please put any Wiki content in MoinMoin. If we are committed to moving to confluence, let's move everything. Was there some progress on this issue at ApacheCon? Thanks, Aaron On 1/18/06, Jules Gosnell [EMAIL PROTECTED] wrote: Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules -- Open Source is a self-assembling organism. You dangle a piece of string into a super-saturated solution and a whole operating-system crystallises out around it. /** * Jules Gosnell * Partner * Core Developers Network (Europe) * *www.coredevelopers.net * * Open Source Training Support. **/
Re: Clustering - initial overview doc... - where should we keep it ?
Hi Jules, many of the articles (if not all) started the same way and many of them are still a work in progress. It would be great if you can publish your doc there, I can give you a hand with the confluence formatting if you want to. Cheers! Hernan Jules Gosnell wrote: Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules
Re: Clustering - initial overview doc... - where should we keep it ?
So where is this document now? I am not very familiar with the web site there seems to be more than one place. On Wed, 18 Jan 2006, Hernan Cunico wrote: Hi Jules, many of the articles (if not all) started the same way and many of them are still a work in progress. It would be great if you can publish your doc there, I can give you a hand with the confluence formatting if you want to. Cheers! Hernan Jules Gosnell wrote: Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules
Re: Clustering - initial overview doc... - where should we keep it ?
Hey Hernan, If u can publish a few tips on basic formatting with confluence that will help. Maybe an email or a doc itself within confluence will do. Regards, Rajith. On 1/18/06, lichtner [EMAIL PROTECTED] wrote: So where is this document now? I am not very familiar with the web sitethere seems to be more than one place. On Wed, 18 Jan 2006, Hernan Cunico wrote: Hi Jules, many of the articles (if not all) started the same way and many of them are still a work in progress. It would be great if you can publish your doc there, I can give you a hand with the confluence formatting if you want to. Cheers! Hernan Jules Gosnell wrote: Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules
Re: Clustering - initial overview doc... - where should we keep it ?
Jules has the documentation for clustering and I am suggesting him to get that documentation published in confluence. Currently, there is just an empty entry in the Table of Contents pointing to *Clustering* in the *Performance and high availability* section. You can see the TOC here http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Cheers! Hernan lichtner wrote: So where is this document now? I am not very familiar with the web site there seems to be more than one place. On Wed, 18 Jan 2006, Hernan Cunico wrote: Hi Jules, many of the articles (if not all) started the same way and many of them are still a work in progress. It would be great if you can publish your doc there, I can give you a hand with the confluence formatting if you want to. Cheers! Hernan Jules Gosnell wrote: Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules
Re: Clustering - initial overview doc... - where should we keep it ?
Hi Rajith, the following link is the *Notation Guide* for confluence that provides available formats. http://opensource2.atlassian.com/confluence/oss/renderer/notationhelp.action?section=all Here are just a few tips for writing documentation that I have found useful. - read other articles published in confluence to have a feel of the structure and organization of other articles for consistency. - keep it simple; don't use too many different fonts and styles. - create a hierarchical structure first, work on titles and sections first then focus on the content. - keep it simple[2], don't use fancy words to explain simple things. - make sure the article has a flow and it is easy to follow. - keep it simple[3], if the topic being addressed in complex, separate the article in multiple sections/pages. - if samples are included, make sure the instructions to get it working are clear. Again, these are just a few tips I try to follow myself. Comments are welcome. HTH Cheers! Hernan Rajith Attapattu wrote: Hey Hernan, If u can publish a few tips on basic formatting with confluence that will help. Maybe an email or a doc itself within confluence will do. Regards, Rajith. On 1/18/06, *lichtner* [EMAIL PROTECTED] mailto:[EMAIL PROTECTED] wrote: So where is this document now? I am not very familiar with the web site there seems to be more than one place. On Wed, 18 Jan 2006, Hernan Cunico wrote: Hi Jules, many of the articles (if not all) started the same way and many of them are still a work in progress. It would be great if you can publish your doc there, I can give you a hand with the confluence formatting if you want to. Cheers! Hernan Jules Gosnell wrote: Hernan Cunico wrote: Hi Jules, can you put your docs in confluence!? There is already a section for performance in the TOC, it would be great if you put the clustering documentation there. OK - can do, if everyone is happy with this... It is a pretty rough doc though... the rest of the stuff in there looks pretty polished... - this really is a work in progress... - is that OK ? Jules Here is the link to the TOC, to edit confluence you will have to register first. http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692 Let me know if you need any help with confluence. Cheers! Hernan Jules Gosnell wrote: Guys, I have the beginnings of this doc... Where would be the best place to keep it ? Ideally it should be r/w by everyone, with history - SVN, WIKI or where ? What is best practice ? Also, if in SVN, what format - text, html, ... etc... Jules
