You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cxf.apache.org by Christian Schneider <ch...@die-schneider.net> on 2007/10/25 23:14:10 UTC
Suggestion for new Main Wiki page for documentation
Hello,
The user documentation Wiki main page has grown quite large and is not
very well structured. I suggest a discussion about a new structure. If
there is positive feedback the main page could be changed.
I have created a new page and restructured some of the links:
http://cwiki.apache.org/confluence/display/CXF20DOC/Idea+for+new+Index
I have also created a Jira Issue where we can discuss the changes and
hopefully get some positive feedback.
I would be very intersted in your comments. Also feel free to change my
page if you have other ideas.
Best regards
Christian
--
Christian Schneider
---
http://www.liquid-reality.de
Re: Suggestion for new Main Wiki page for documentation
Posted by Bozhong Lin <bo...@gmail.com>.
Looks great to me!
BTW, Eclipse Tooling for CXF (in Eclipse STP) has release its 0.7 version
[1] and we need to update its related document. In case anyone has
interesting doing update, I filed a JIRA here [2].
The latest Eclipse STP version (snapshot version) has also done significant
improvement to Java First Approach (include Aegis binding support!). If
anyone to try it out, go ahead to Eclipse STP site and try it.
Cheers,
Bo
[1]
http://wiki.eclipse.org/STP_Service_Creation_getting_started_guide_for_stp_0.7
[2] https://issues.apache.org/jira/browse/CXF-1165
On 11/2/07, Christian Schneider <ch...@die-schneider.net> wrote:
>
> Hi,
>
> I have switched the index page to the new content.
> To keep consistency I think we should also change the navigation page.
> Like with the Index page I have added a new Wiki page for discussion:
> http://cwiki.apache.org/confluence/display/CXF20DOC/Navigation+New
>
> I have already synced to page to the Index structure.
>
> What do you think?
>
> Best regards
>
> Christian
>
>
> Daniel Kulp schrieb:
> > +1 to making the switch.
> >
> > Dan
> >
> >
>
Re: Suggestion for new Main Wiki page for documentation
Posted by Bozhong Lin <bo...@gmail.com>.
Looks great to me!
BTW, Eclipse Tooling for CXF (in Eclipse STP) has release its 0.7 version
[1] and we need to update its related document. In case anyone has
interesting doing update, I filed a JIRA here [2].
The latest Eclipse STP version (snapshot version) has also done significant
improvement to Java First Approach (include Aegis binding support!). If
anyone to try it out, go ahead to Eclipse STP site and try it.
Cheers,
Bo
[1]
http://wiki.eclipse.org/STP_Service_Creation_getting_started_guide_for_stp_0.7
[2] https://issues.apache.org/jira/browse/CXF-1165
On 11/2/07, Christian Schneider <ch...@die-schneider.net> wrote:
>
> Hi,
>
> I have switched the index page to the new content.
> To keep consistency I think we should also change the navigation page.
> Like with the Index page I have added a new Wiki page for discussion:
> http://cwiki.apache.org/confluence/display/CXF20DOC/Navigation+New
>
> I have already synced to page to the Index structure.
>
> What do you think?
>
> Best regards
>
> Christian
>
>
> Daniel Kulp schrieb:
> > +1 to making the switch.
> >
> > Dan
> >
> >
>
Re: Suggestion for new Main Wiki page for documentation
Posted by Christian Schneider <ch...@die-schneider.net>.
Hi,
I have switched the index page to the new content.
To keep consistency I think we should also change the navigation page.
Like with the Index page I have added a new Wiki page for discussion:
http://cwiki.apache.org/confluence/display/CXF20DOC/Navigation+New
I have already synced to page to the Index structure.
What do you think?
Best regards
Christian
Daniel Kulp schrieb:
> +1 to making the switch.
>
> Dan
>
>
> On Wednesday 31 October 2007, Bozhong Lin wrote:
>
>> Hi Christian,
>>
>> I'd say this is great suggestions and I think we can go on and switch.
>> We always can improve if people have other suggestions.
>>
>> Thanks for this great work!
>>
>> Cheers,
>> Bo
>>
>> On 10/31/07, Christian Schneider <ch...@die-schneider.net> wrote:
>>
>>> Now that we have implemented some changes to the proposed new index
>>> site, how is your opinion towards the page?
>>> Should we go on and switch?
>>>
>>> Best regards,
>>>
>>> Christian
>>>
>>>
--
Christian Schneider
---
http://www.liquid-reality.de
Re: Suggestion for new Main Wiki page for documentation
Posted by Daniel Kulp <dk...@apache.org>.
+1 to making the switch.
Dan
On Wednesday 31 October 2007, Bozhong Lin wrote:
> Hi Christian,
>
> I'd say this is great suggestions and I think we can go on and switch.
> We always can improve if people have other suggestions.
>
> Thanks for this great work!
>
> Cheers,
> Bo
>
> On 10/31/07, Christian Schneider <ch...@die-schneider.net> wrote:
> > Now that we have implemented some changes to the proposed new index
> > site, how is your opinion towards the page?
> > Should we go on and switch?
> >
> > Best regards,
> >
> > Christian
> >
> > Christian Schneider schrieb:
> > > Hello,
> > >
> > > The user documentation Wiki main page has grown quite large and is
> > > not very well structured. I suggest a discussion about a new
> > > structure. If there is positive feedback the main page could be
> > > changed.
> > >
> > > I have created a new page and restructured some of the links:
> > > http://cwiki.apache.org/confluence/display/CXF20DOC/Idea+for+new+I
> > >ndex
> > >
> > > I have also created a Jira Issue where we can discuss the changes
> > > and hopefully get some positive feedback.
> > > I would be very intersted in your comments. Also feel free to
> > > change my page if you have other ideas.
> > >
> > > Best regards
> > >
> > > Christian
> >
> > --
> >
> > Christian Schneider
> > ---
> > http://www.liquid-reality.de
--
J. Daniel Kulp
Principal Engineer
IONA
P: 781-902-8727 C: 508-380-7194
daniel.kulp@iona.com
http://www.dankulp.com/blog
Re: Suggestion for new Main Wiki page for documentation
Posted by Bozhong Lin <bo...@gmail.com>.
Hi Christian,
I'd say this is great suggestions and I think we can go on and switch. We
always can improve if people have other suggestions.
Thanks for this great work!
Cheers,
Bo
On 10/31/07, Christian Schneider <ch...@die-schneider.net> wrote:
>
> Now that we have implemented some changes to the proposed new index
> site, how is your opinion towards the page?
> Should we go on and switch?
>
> Best regards,
>
> Christian
>
> Christian Schneider schrieb:
> > Hello,
> >
> > The user documentation Wiki main page has grown quite large and is not
> > very well structured. I suggest a discussion about a new structure. If
> > there is positive feedback the main page could be changed.
> >
> > I have created a new page and restructured some of the links:
> > http://cwiki.apache.org/confluence/display/CXF20DOC/Idea+for+new+Index
> >
> > I have also created a Jira Issue where we can discuss the changes and
> > hopefully get some positive feedback.
> > I would be very intersted in your comments. Also feel free to change
> > my page if you have other ideas.
> >
> > Best regards
> >
> > Christian
> >
>
>
> --
>
> Christian Schneider
> ---
> http://www.liquid-reality.de
>
>
Re: Suggestion for new Main Wiki page for documentation
Posted by Christian Schneider <ch...@die-schneider.net>.
Now that we have implemented some changes to the proposed new index
site, how is your opinion towards the page?
Should we go on and switch?
Best regards,
Christian
Christian Schneider schrieb:
> Hello,
>
> The user documentation Wiki main page has grown quite large and is not
> very well structured. I suggest a discussion about a new structure. If
> there is positive feedback the main page could be changed.
>
> I have created a new page and restructured some of the links:
> http://cwiki.apache.org/confluence/display/CXF20DOC/Idea+for+new+Index
>
> I have also created a Jira Issue where we can discuss the changes and
> hopefully get some positive feedback.
> I would be very intersted in your comments. Also feel free to change
> my page if you have other ideas.
>
> Best regards
>
> Christian
>
--
Christian Schneider
---
http://www.liquid-reality.de
Re: Suggestion for new Main Wiki page for documentation
Posted by Jeff Yu <je...@iona.com>.
Hi, Chris
See my comments inline
Thanks
Jeff
Christian Schneider wrote:
> Thanks for the comment.
>
> Jeff Yu schrieb:
>> Hi, Christian
>>
>> I like the new structure mostly, below are some my comments:
>>
>> 1. I'd like to have full levels in the TOC, so people can see all the
>> stuff or even can use search functionality in the index page. for
>> example:
> This is of course possible. But in this case we should rely on the
> children macro with unlimited depth below the main topics. So we know
> the main page keeps in sync with the content.
> The problem is that the page will grow extremly. For soemone who wants
> to search something we can add a search button. I will show an example.
> The main problem I see with displaying all pages is that a human being
> can only comfortable work with up to about 10 elements per level. If
> you show all it will be quite confusing.
>
> Another possible solution would be to offer a second sitemap page that
> is completely automatic. I will also post a sample. The problem with a
> fully automated page is that you do not have much influence on the
> ordering.
I mean 3 levels at this case, not the unlimited depth. If users add a
new page, and want to be shown in the index page, they need to add it to
index manually.
>>
>> Frontends
>>
>> * JAX-WS Frontend
>> <http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
>> * Simple Frontend
>>
>> <http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
>> * Dynamic Clients
>>
>> <http://cwiki.apache.org/confluence/display/CXF20DOC/Dynamic+Clients>
> Agreed.
>>
>>
>> 2. MTOM attachment and JSON Support do not belong to databinding.
> Where could we put these? I think they should not be on the top level
> but I also knew that databinding was probably not right.
Maybe we can put the "JSON support" into the Restulf Service node...
people use json, most of them are using restful service, I think.
>>
>> 3. It seems it is missing the wsdl binding part in the new index page.
> I put it to the WS-* support. Also knowing that this is perhaps not
> right. Should I put it back to the top?
I think put it back to top is better, since it is not belonged to ws-*
stuff.
>>
>> Thanks
>> Jeff
> Best regards
>
> Christian
>
Re: Suggestion for new Main Wiki page for documentation
Posted by Christian Schneider <ch...@die-schneider.net>.
Thanks for the comment.
Jeff Yu schrieb:
> Hi, Christian
>
> I like the new structure mostly, below are some my comments:
>
> 1. I'd like to have full levels in the TOC, so people can see all the
> stuff or even can use search functionality in the index page. for
> example:
This is of course possible. But in this case we should rely on the
children macro with unlimited depth below the main topics. So we know
the main page keeps in sync with the content.
The problem is that the page will grow extremly. For soemone who wants
to search something we can add a search button. I will show an example.
The main problem I see with displaying all pages is that a human being
can only comfortable work with up to about 10 elements per level. If you
show all it will be quite confusing.
Another possible solution would be to offer a second sitemap page that
is completely automatic. I will also post a sample. The problem with a
fully automated page is that you do not have much influence on the
ordering.
>
> Frontends
>
> * JAX-WS Frontend
> <http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
> * Simple Frontend
>
> <http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
> * Dynamic Clients
>
> <http://cwiki.apache.org/confluence/display/CXF20DOC/Dynamic+Clients>
Agreed.
>
>
> 2. MTOM attachment and JSON Support do not belong to databinding.
Where could we put these? I think they should not be on the top level
but I also knew that databinding was probably not right.
>
> 3. It seems it is missing the wsdl binding part in the new index page.
I put it to the WS-* support. Also knowing that this is perhaps not
right. Should I put it back to the top?
>
> Thanks
> Jeff
Best regards
Christian
--
Christian Schneider
---
http://www.liquid-reality.de
Re: Suggestion for new Main Wiki page for documentation
Posted by Glen Mazza <gl...@verizon.net>.
Thanks for the clarification.
Glen
Am Montag, den 29.10.2007, 09:57 +0800 schrieb Bozhong Lin:
> So to be specific, yes, simple frontend means "Java-First but Non-Annotated
> Frontend", creating a web service based on a POJO implementation (not SEI).
> Eclipse STP tooling will also this scenario.
>
> Cheers,
> Bo
>
> On 10/28/07, Willem2 <ni...@iona.com> wrote:
> >
> >
> > The front-end has not thing to with the http transportation which we could
> > use Jetty to implement.
> > It just relates to how we can get the service creation information :)
> >
> > Willem.
> >
> >
> > Glen Mazza-2 wrote:
> > >
> > > Am Freitag, den 26.10.2007, 13:28 +0800 schrieb Jeff Yu:
> > >> Hi, Christian
> > >>
> > >> I like the new structure mostly, below are some my comments:
> > >>
> > >> 1. I'd like to have full levels in the TOC, so people can see all the
> > >> stuff or even can use search functionality in the index page. for
> > >> example:
> > >>
> > >> Frontends
> > >>
> > >> * JAX-WS Frontend
> > >> <http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
> > >> * Simple Frontend
> > >>
> > >> <http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
> > >
> > >
> > > BTW, what does the "Simple Frontend" actually mean--does it mean the
> > > "Jetty Frontend" or does it mean the "Java-First but Non-Annotated
> > > Frontend"?
> > >
> > > Thanks,
> > > Glen
> > >
> > >
> > >
> > >
> >
> > --
> > View this message in context:
> > http://www.nabble.com/Suggestion-for-new-Main-Wiki-page-for-documentation-tf4693749.html#a13449140
> > Sent from the cxf-dev mailing list archive at Nabble.com.
> >
> >
Re: Suggestion for new Main Wiki page for documentation
Posted by Bozhong Lin <bo...@gmail.com>.
So to be specific, yes, simple frontend means "Java-First but Non-Annotated
Frontend", creating a web service based on a POJO implementation (not SEI).
Eclipse STP tooling will also this scenario.
Cheers,
Bo
On 10/28/07, Willem2 <ni...@iona.com> wrote:
>
>
> The front-end has not thing to with the http transportation which we could
> use Jetty to implement.
> It just relates to how we can get the service creation information :)
>
> Willem.
>
>
> Glen Mazza-2 wrote:
> >
> > Am Freitag, den 26.10.2007, 13:28 +0800 schrieb Jeff Yu:
> >> Hi, Christian
> >>
> >> I like the new structure mostly, below are some my comments:
> >>
> >> 1. I'd like to have full levels in the TOC, so people can see all the
> >> stuff or even can use search functionality in the index page. for
> >> example:
> >>
> >> Frontends
> >>
> >> * JAX-WS Frontend
> >> <http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
> >> * Simple Frontend
> >>
> >> <http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
> >
> >
> > BTW, what does the "Simple Frontend" actually mean--does it mean the
> > "Jetty Frontend" or does it mean the "Java-First but Non-Annotated
> > Frontend"?
> >
> > Thanks,
> > Glen
> >
> >
> >
> >
>
> --
> View this message in context:
> http://www.nabble.com/Suggestion-for-new-Main-Wiki-page-for-documentation-tf4693749.html#a13449140
> Sent from the cxf-dev mailing list archive at Nabble.com.
>
>
Re: Suggestion for new Main Wiki page for documentation
Posted by Willem2 <ni...@iona.com>.
The front-end has not thing to with the http transportation which we could
use Jetty to implement.
It just relates to how we can get the service creation information :)
Willem.
Glen Mazza-2 wrote:
>
> Am Freitag, den 26.10.2007, 13:28 +0800 schrieb Jeff Yu:
>> Hi, Christian
>>
>> I like the new structure mostly, below are some my comments:
>>
>> 1. I'd like to have full levels in the TOC, so people can see all the
>> stuff or even can use search functionality in the index page. for
>> example:
>>
>> Frontends
>>
>> * JAX-WS Frontend
>> <http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
>> * Simple Frontend
>>
>> <http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
>
>
> BTW, what does the "Simple Frontend" actually mean--does it mean the
> "Jetty Frontend" or does it mean the "Java-First but Non-Annotated
> Frontend"?
>
> Thanks,
> Glen
>
>
>
>
--
View this message in context: http://www.nabble.com/Suggestion-for-new-Main-Wiki-page-for-documentation-tf4693749.html#a13449140
Sent from the cxf-dev mailing list archive at Nabble.com.
Re: Suggestion for new Main Wiki page for documentation
Posted by Glen Mazza <gl...@verizon.net>.
Am Freitag, den 26.10.2007, 13:28 +0800 schrieb Jeff Yu:
> Hi, Christian
>
> I like the new structure mostly, below are some my comments:
>
> 1. I'd like to have full levels in the TOC, so people can see all the
> stuff or even can use search functionality in the index page. for example:
>
> Frontends
>
> * JAX-WS Frontend
> <http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
> * Simple Frontend
> <http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
BTW, what does the "Simple Frontend" actually mean--does it mean the
"Jetty Frontend" or does it mean the "Java-First but Non-Annotated
Frontend"?
Thanks,
Glen
Re: Suggestion for new Main Wiki page for documentation
Posted by Jeff Yu <je...@iona.com>.
Hi, Christian
I like the new structure mostly, below are some my comments:
1. I'd like to have full levels in the TOC, so people can see all the
stuff or even can use search functionality in the index page. for example:
Frontends
* JAX-WS Frontend
<http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
* Simple Frontend
<http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
* Dynamic Clients
<http://cwiki.apache.org/confluence/display/CXF20DOC/Dynamic+Clients>
I'd like:
Frontends
* JAX-WS Frontend
<http://cwiki.apache.org/confluence/display/CXF20DOC/JAX-WS>
* * _Developing a consumer_
* * _Developing a service_
* ......
* Simple Frontend
<http://cwiki.apache.org/confluence/display/CXF20DOC/Simple+Frontend>
* Dynamic Clients
<http://cwiki.apache.org/confluence/display/CXF20DOC/Dynamic+Clients>
Same goes to: Configuration, HTTPTransport, RestfulService etc.
2. MTOM attachment and JSON Support do not belong to databinding.
3. It seems it is missing the wsdl binding part in the new index page.
Thanks
Jeff
Christian Schneider wrote:
> Hello,
>
> The user documentation Wiki main page has grown quite large and is not
> very well structured. I suggest a discussion about a new structure. If
> there is positive feedback the main page could be changed.
>
> I have created a new page and restructured some of the links:
> http://cwiki.apache.org/confluence/display/CXF20DOC/Idea+for+new+Index
>
> I have also created a Jira Issue where we can discuss the changes and
> hopefully get some positive feedback.
> I would be very intersted in your comments. Also feel free to change
> my page if you have other ideas.
>
> Best regards
>
> Christian
>