Re: Doc reorg
On 3/15/07, Eduardo de Vera <[EMAIL PROTECTED]> wrote: Hi, I work for a company that is very interested in ServiceMix as the ESB to use in our projects. And, since we are a spanish company, we are seriously considering translating the documentation to spanish. Great! :) I would like to know some stuff before getting my hands to work: - Would it be possible to post those translations on our own web page? Under which conditions? I have read the Apache Software Licence and its seems that the only requisite is to mantain the copyright of the original author as well as the trademarks of Apache. You can translate and reuse any documentation as its licensed under the Apache license. - Would the ServiceMix and Apache orgs like to get the translations for using them on their web pages? My preference would be to host the spanish translation on an Apache wiki; then other folks can help contribute to keeping the spanish documentation up to date. e.g. we could have an entire ServiceMix-Spanish wiki for all spanish documentation and link to it from the home page; then the entire site/nav bar could be spanish? -- James --- http://radio.weblogs.com/0112098/
Re: Doc reorg
On 3/15/07, Rossmanith, Philipp <[EMAIL PROTECTED]> wrote: Hi, I always liked the documentation of Apache Cocoon, where you have a separation into documentation for developers (people that want to hack code improving the framework) and users (people who want to use the framework without actually modifying it) and some other tracks. They solve the overload problem by having collapsible menus. Is that something that could be done for SM? Its a good idea - we could maybe have different navigation bars for users v developers etc. -- James --- http://radio.weblogs.com/0112098/
Re: Doc reorg
Hi, I work for a company that is very interested in ServiceMix as the ESB to use in our projects. And, since we are a spanish company, we are seriously considering translating the documentation to spanish. I would like to know some stuff before getting my hands to work: - Would it be possible to post those translations on our own web page? Under which conditions? I have read the Apache Software Licence and its seems that the only requisite is to mantain the copyright of the original author as well as the trademarks of Apache. - Would the ServiceMix and Apache orgs like to get the translations for using them on their web pages? Thanks, best regards, 2007/3/15, Rossmanith, Philipp <[EMAIL PROTECTED]>: Hi, I always liked the documentation of Apache Cocoon, where you have a separation into documentation for developers (people that want to hack code improving the framework) and users (people who want to use the framework without actually modifying it) and some other tracks. They solve the overload problem by having collapsible menus. Is that something that could be done for SM? Ciao, Philipp Rossmanith > -Mensaje original- > De: James Strachan [mailto:[EMAIL PROTECTED] > Enviado el: lunes, 05 de marzo de 2007 15:25 > Para: servicemix-dev@geronimo.apache.org > Asunto: Re: Doc reorg > > On 2/21/07, Guillaume Nodet <[EMAIL PROTECTED]> wrote: > > I think we need to reorg the docs so that one can more easily > > find the informations (we also need to write more docs, but that's > > another problem). Currently, the only way to really find a page is > > to go to the site map and browse ... > > > > Any ideas on how to do that ? > > Its a tricky one. In some ways having a kinda SiteMap menu thingy on > the home page/navigation bar can help folks who know-what-they-want > navigate quickly to the right stuff. Sometimes that can be kinda > overload where new users don't know where to start (e.g. in the past > the ActiveMQ site has suffered, and still does I think, from > navigation-bar-overload). > > Maybe we need to put a bit more of the SiteMap onto the Navigation > bar? I wonder if CSS style popup menus might help reduce some of the > clutter of the Navigation bar while adding more of the SiteMap to the > average user? > http://www.grc.com/menu2/invitro.htm > > -- > > James > --- > http://radio.weblogs.com/0112098/ This e-mail may contain confidential or privileged information. Any unauthorised copying, use or distribution of this information is strictly prohibited. -- Eduardo de Vera Sun Certified Programmer for the Java 2 Platform 1.4 blog -> http://blogandshare.blogspot.com
RE: Doc reorg
Hi, I always liked the documentation of Apache Cocoon, where you have a separation into documentation for developers (people that want to hack code improving the framework) and users (people who want to use the framework without actually modifying it) and some other tracks. They solve the overload problem by having collapsible menus. Is that something that could be done for SM? Ciao, Philipp Rossmanith > -Mensaje original- > De: James Strachan [mailto:[EMAIL PROTECTED] > Enviado el: lunes, 05 de marzo de 2007 15:25 > Para: servicemix-dev@geronimo.apache.org > Asunto: Re: Doc reorg > > On 2/21/07, Guillaume Nodet <[EMAIL PROTECTED]> wrote: > > I think we need to reorg the docs so that one can more easily > > find the informations (we also need to write more docs, but that's > > another problem). Currently, the only way to really find a page is > > to go to the site map and browse ... > > > > Any ideas on how to do that ? > > Its a tricky one. In some ways having a kinda SiteMap menu thingy on > the home page/navigation bar can help folks who know-what-they-want > navigate quickly to the right stuff. Sometimes that can be kinda > overload where new users don't know where to start (e.g. in the past > the ActiveMQ site has suffered, and still does I think, from > navigation-bar-overload). > > Maybe we need to put a bit more of the SiteMap onto the Navigation > bar? I wonder if CSS style popup menus might help reduce some of the > clutter of the Navigation bar while adding more of the SiteMap to the > average user? > http://www.grc.com/menu2/invitro.htm > > -- > > James > --- > http://radio.weblogs.com/0112098/ This e-mail may contain confidential or privileged information. Any unauthorised copying, use or distribution of this information is strictly prohibited.
Re: Doc reorg
On 2/21/07, Guillaume Nodet <[EMAIL PROTECTED]> wrote: I think we need to reorg the docs so that one can more easily find the informations (we also need to write more docs, but that's another problem). Currently, the only way to really find a page is to go to the site map and browse ... Any ideas on how to do that ? Its a tricky one. In some ways having a kinda SiteMap menu thingy on the home page/navigation bar can help folks who know-what-they-want navigate quickly to the right stuff. Sometimes that can be kinda overload where new users don't know where to start (e.g. in the past the ActiveMQ site has suffered, and still does I think, from navigation-bar-overload). Maybe we need to put a bit more of the SiteMap onto the Navigation bar? I wonder if CSS style popup menus might help reduce some of the clutter of the Navigation bar while adding more of the SiteMap to the average user? http://www.grc.com/menu2/invitro.htm -- James --- http://radio.weblogs.com/0112098/
Re: Doc reorg
On 2/22/07, Terry Cox <[EMAIL PROTECTED]> wrote: > Any ideas on how to do that ? You need more than one way to get to information as people will use different strategies to find out about a new technology. I personally like to know at a glance the scope of a project, so I preferred the original approach (and the one taken on the ActiveMQ site) of having lots of left menu items for each topic, component or significant point. Yeah, we need to add some back. Do you have any suggestions ? The documentation is probably weakest on practical examples, judging by the sort of support queries coming in. There should be explicit tutorials for binding to a foreign web service, exposing a web service, wrapping a POJO, creating JBI components, packaging and deploying using su/sa, applying security. Agreed, there are some tutorials in the way, but we need more of course. The examples from the distribution may be used too, but not all are really documented. We also need to do a better job of keeping these up to date and making it clear which documentation refers to which release. Yeah, if you see some unclear areas, just send a mail so that we can fix them. -- Terry -- Cheers, Guillaume Nodet Architect, LogicBlaze (http://www.logicblaze.com/) Blog: http://gnodet.blogspot.com/
Re: Doc reorg
On 2/21/07, Guillaume Nodet <[EMAIL PROTECTED]> wrote:
I think we need to reorg the docs so that one can more easily
find the informations (we also need to write more docs, but that's
another problem). Currently, the only way to really find a page is
to go to the site map and browse ...
Any ideas on how to do that ?
I like the User's Guide concept, but I think we should return to
having more links to information exposed in order to help users find
the buried information in an easier manner.
I also agree with Terry about the common examples. I've already begun
working on some of these examples, but none of them are complete yet.
I started Hello World style examples for creating a BC and a SE as
well as providing and consuming a web service. I just need to make
some time to complete them.
Bruce
--
perl -e 'print unpack("u30","D0G)[EMAIL
PROTECTED]&5R\"F)R=6-E+G-N>61Ehttp://geronimo.apache.org/
Apache ActiveMQ - http://activemq.org/
Apache ServiceMix - http://servicemix.org/
Castor - http://castor.org/
Re: Doc reorg
Any ideas on how to do that ? You need more than one way to get to information as people will use different strategies to find out about a new technology. I personally like to know at a glance the scope of a project, so I preferred the original approach (and the one taken on the ActiveMQ site) of having lots of left menu items for each topic, component or significant point. The documentation is probably weakest on practical examples, judging by the sort of support queries coming in. There should be explicit tutorials for binding to a foreign web service, exposing a web service, wrapping a POJO, creating JBI components, packaging and deploying using su/sa, applying security. We also need to do a better job of keeping these up to date and making it clear which documentation refers to which release. -- Terry
