You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tuscany.apache.org by Luciano Resende <lu...@gmail.com> on 2009/11/01 17:52:17 UTC
Tuscany 2.x Documentation
I have noticed that people have started to be more active on writing
2.x documentation, but they are being scattered all over the different
wikis we have. I'd like to suggest we concentrate in using the 2.x
documentation wiki [1] which is linked from the website as the proper
documentation for 2.x. If there are issues with that, let me know and
I can volunteer to make it better. I will also try to move some of the
existent 2.x contents to the 2.x documentation wiki.
[1] http://cwiki.apache.org/confluence/display/TUSCANYxDOCx2x/Index
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by Simon Laws <si...@googlemail.com>.
I've done the change so I await the export to see if it works.
Simon
Re: Tuscany 2.x Documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Fri, Jan 15, 2010 at 5:40 AM, Simon Laws <si...@googlemail.com> wrote:
> Hi, Just checking up on this. Was about to fix the link on our java
> home page (http://tuscany.apache.org/sca-java.html) that still points,
> via some tiny URL, to the wiki version but then stopped just in case
> it was still being help back for some reason.
>
> I'd like to go ahead and fix the link ASAP so shout if it needs to stay as is.
>
> Simon
>
Looks like you are saying that you want to point to the exported html version...
+1
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by Simon Laws <si...@googlemail.com>.
Hi, Just checking up on this. Was about to fix the link on our java
home page (http://tuscany.apache.org/sca-java.html) that still points,
via some tiny URL, to the wiki version but then stopped just in case
it was still being help back for some reason.
I'd like to go ahead and fix the link ASAP so shout if it needs to stay as is.
Simon
Re: Tuscany 2.x Documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Mon, Nov 16, 2009 at 9:53 AM, Luciano Resende <lu...@gmail.com> wrote:
> On Sun, Nov 15, 2009 at 8:38 AM, Luciano Resende <lu...@gmail.com> wrote:
>> Things are getting in better shape, I just need to figure out how to
>> properly populate the outline navigation when exporting to html, but
>> other then that it seems pretty much aligned with the website layout
>> now :
>>
>> http://people.apache.org/~lresende/tuscany-2x-doc/
>>
>
> Most of the issues are now resolved with the latest tweaks to the
> export template and the only remaining issue is the left
> treeNavigation. If people feel are comfortable with the current look
> and feel, I'll start syncing it to the live Tuscany website.
>
This is now live from the Tuscany web site:
http://tuscany.apache.org/documentation-2x/
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Sun, Nov 15, 2009 at 8:38 AM, Luciano Resende <lu...@gmail.com> wrote:
> Things are getting in better shape, I just need to figure out how to
> properly populate the outline navigation when exporting to html, but
> other then that it seems pretty much aligned with the website layout
> now :
>
> http://people.apache.org/~lresende/tuscany-2x-doc/
>
Most of the issues are now resolved with the latest tweaks to the
export template and the only remaining issue is the left
treeNavigation. If people feel are comfortable with the current look
and feel, I'll start syncing it to the live Tuscany website.
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Mon, Nov 9, 2009 at 1:16 AM, ant elder <an...@apache.org> wrote:
>>
>> The idea is to have the chapter navigation available for the
>> documentation, with some way to go back to the website. IMO, having
>> multiple navigation menus on the left side will take too much space
>> from the content page.
>>
>
> OK, I guess it will be easier to see how it looks once its properly
> part of the live website. How is that going BTW, have you been able to
> figure out a way to get that happen?
>
Things are getting in better shape, I just need to figure out how to
properly populate the outline navigation when exporting to html, but
other then that it seems pretty much aligned with the website layout
now :
http://people.apache.org/~lresende/tuscany-2x-doc/
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by ant elder <an...@apache.org>.
On Sat, Nov 7, 2009 at 4:19 PM, Luciano Resende <lu...@gmail.com> wrote:
> On Sat, Nov 7, 2009 at 12:01 AM, ant elder <an...@apache.org> wrote:
>> On Fri, Nov 6, 2009 at 11:51 PM, Luciano Resende <lu...@gmail.com> wrote:
>>> On Tue, Nov 3, 2009 at 2:47 AM, ant elder <an...@apache.org> wrote:
>>>> I think the main thing is getting it working at tuscany.apache.org.
>>>> Once that works it will be easier to see how it looks, and i'd be
>>>> happy to help port up the existing 1.x doc to 2.x.
>>>>
>>>> ...ant
>>>
>>> As look and feel is sometime trick, before I go and start applying
>>> things all over, I want to check if people are ok with the direction.
>>> Below is a exported section, partially updated to use the
>>> tuscany.apache.org skin, but not synced to live website for now.
>>>
>>> http://cwiki.apache.org/TUSCANYxDOCx2x/
>>>
>>> Please let me know your thoughts ...
>>>
>>
>> What about the navigation menu on the left that the regular Tuscany
>> website pages have (i.e. {include: SimpleMenu} )? Is that not there
>> just because this isn't properly part of the website yet?
>>
>> ...ant
>>
>
> The idea is to have the chapter navigation available for the
> documentation, with some way to go back to the website. IMO, having
> multiple navigation menus on the left side will take too much space
> from the content page.
>
OK, I guess it will be easier to see how it looks once its properly
part of the live website. How is that going BTW, have you been able to
figure out a way to get that happen?
...ant
Re: Tuscany 2.x Documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Sat, Nov 7, 2009 at 12:01 AM, ant elder <an...@apache.org> wrote:
> On Fri, Nov 6, 2009 at 11:51 PM, Luciano Resende <lu...@gmail.com> wrote:
>> On Tue, Nov 3, 2009 at 2:47 AM, ant elder <an...@apache.org> wrote:
>>> I think the main thing is getting it working at tuscany.apache.org.
>>> Once that works it will be easier to see how it looks, and i'd be
>>> happy to help port up the existing 1.x doc to 2.x.
>>>
>>> ...ant
>>
>> As look and feel is sometime trick, before I go and start applying
>> things all over, I want to check if people are ok with the direction.
>> Below is a exported section, partially updated to use the
>> tuscany.apache.org skin, but not synced to live website for now.
>>
>> http://cwiki.apache.org/TUSCANYxDOCx2x/
>>
>> Please let me know your thoughts ...
>>
>
> What about the navigation menu on the left that the regular Tuscany
> website pages have (i.e. {include: SimpleMenu} )? Is that not there
> just because this isn't properly part of the website yet?
>
> ...ant
>
The idea is to have the chapter navigation available for the
documentation, with some way to go back to the website. IMO, having
multiple navigation menus on the left side will take too much space
from the content page.
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by ant elder <an...@apache.org>.
On Fri, Nov 6, 2009 at 11:51 PM, Luciano Resende <lu...@gmail.com> wrote:
> On Tue, Nov 3, 2009 at 2:47 AM, ant elder <an...@apache.org> wrote:
>> I think the main thing is getting it working at tuscany.apache.org.
>> Once that works it will be easier to see how it looks, and i'd be
>> happy to help port up the existing 1.x doc to 2.x.
>>
>> ...ant
>
> As look and feel is sometime trick, before I go and start applying
> things all over, I want to check if people are ok with the direction.
> Below is a exported section, partially updated to use the
> tuscany.apache.org skin, but not synced to live website for now.
>
> http://cwiki.apache.org/TUSCANYxDOCx2x/
>
> Please let me know your thoughts ...
>
What about the navigation menu on the left that the regular Tuscany
website pages have (i.e. {include: SimpleMenu} )? Is that not there
just because this isn't properly part of the website yet?
...ant
Re: Tuscany 2.x Documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Tue, Nov 3, 2009 at 2:47 AM, ant elder <an...@apache.org> wrote:
> I think the main thing is getting it working at tuscany.apache.org.
> Once that works it will be easier to see how it looks, and i'd be
> happy to help port up the existing 1.x doc to 2.x.
>
> ...ant
As look and feel is sometime trick, before I go and start applying
things all over, I want to check if people are ok with the direction.
Below is a exported section, partially updated to use the
tuscany.apache.org skin, but not synced to live website for now.
http://cwiki.apache.org/TUSCANYxDOCx2x/
Please let me know your thoughts ...
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by ant elder <an...@apache.org>.
On Mon, Nov 2, 2009 at 5:44 PM, Luciano Resende <lu...@gmail.com> wrote:
> On Mon, Nov 2, 2009 at 5:16 AM, ant elder <an...@gmail.com> wrote:
>> On Sun, Nov 1, 2009 at 4:52 PM, Luciano Resende <lu...@gmail.com> wrote:
>>> I have noticed that people have started to be more active on writing
>>> 2.x documentation, but they are being scattered all over the different
>>> wikis we have. I'd like to suggest we concentrate in using the 2.x
>>> documentation wiki [1] which is linked from the website as the proper
>>> documentation for 2.x. If there are issues with that, let me know and
>>> I can volunteer to make it better. I will also try to move some of the
>>> existent 2.x contents to the 2.x documentation wiki.
>>>
>>> [1] http://cwiki.apache.org/confluence/display/TUSCANYxDOCx2x/Index
>>>
>>
>> There are some problems with using the TUSCANYxDOCx2x wiki space. It
>> doesnt seem to get built into the Tuscany website so links have to be
>> to cwiki.apache.org instead of tuscany.apache.org which the cwiki doc
>> says we shouldn't do. It also means that search engines don't index
>> the doc in the cwiki space which i think would really need to be fixed
>> if we're going to use it. And, I dont know how to say it other than
>> just saying it - IMHO TUSCANYxDOCx2x doesn't look very good, i know it
>> was done this way to try to get the automated PDF generation working
>> but its not consistent with the rest of the Tuscany website and it
>> doesn't look great.
>>
>> ...ant
>>
>
> This is good feedback, so let me see if I understand it correct :
> - We need to export it to be accessible via tuscany.apache.org
> - We need to make it look and feel similar to our website scheme.
>
> How about the navigation style ? My original idea wasn't really about
> the PDF only, but the navigation style that looked more like a
> documentation divided into chapters then just a plain website... I'll
> see if I can apply the feedback above and still maintain the
> navigation style.
>
I think the main thing is getting it working at tuscany.apache.org.
Once that works it will be easier to see how it looks, and i'd be
happy to help port up the existing 1.x doc to 2.x.
...ant
Re: Tuscany 2.x Documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Mon, Nov 2, 2009 at 5:16 AM, ant elder <an...@gmail.com> wrote:
> On Sun, Nov 1, 2009 at 4:52 PM, Luciano Resende <lu...@gmail.com> wrote:
>> I have noticed that people have started to be more active on writing
>> 2.x documentation, but they are being scattered all over the different
>> wikis we have. I'd like to suggest we concentrate in using the 2.x
>> documentation wiki [1] which is linked from the website as the proper
>> documentation for 2.x. If there are issues with that, let me know and
>> I can volunteer to make it better. I will also try to move some of the
>> existent 2.x contents to the 2.x documentation wiki.
>>
>> [1] http://cwiki.apache.org/confluence/display/TUSCANYxDOCx2x/Index
>>
>
> There are some problems with using the TUSCANYxDOCx2x wiki space. It
> doesnt seem to get built into the Tuscany website so links have to be
> to cwiki.apache.org instead of tuscany.apache.org which the cwiki doc
> says we shouldn't do. It also means that search engines don't index
> the doc in the cwiki space which i think would really need to be fixed
> if we're going to use it. And, I dont know how to say it other than
> just saying it - IMHO TUSCANYxDOCx2x doesn't look very good, i know it
> was done this way to try to get the automated PDF generation working
> but its not consistent with the rest of the Tuscany website and it
> doesn't look great.
>
> ...ant
>
This is good feedback, so let me see if I understand it correct :
- We need to export it to be accessible via tuscany.apache.org
- We need to make it look and feel similar to our website scheme.
How about the navigation style ? My original idea wasn't really about
the PDF only, but the navigation style that looked more like a
documentation divided into chapters then just a plain website... I'll
see if I can apply the feedback above and still maintain the
navigation style.
--
Luciano Resende
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany 2.x Documentation
Posted by ant elder <an...@gmail.com>.
On Sun, Nov 1, 2009 at 4:52 PM, Luciano Resende <lu...@gmail.com> wrote:
> I have noticed that people have started to be more active on writing
> 2.x documentation, but they are being scattered all over the different
> wikis we have. I'd like to suggest we concentrate in using the 2.x
> documentation wiki [1] which is linked from the website as the proper
> documentation for 2.x. If there are issues with that, let me know and
> I can volunteer to make it better. I will also try to move some of the
> existent 2.x contents to the 2.x documentation wiki.
>
> [1] http://cwiki.apache.org/confluence/display/TUSCANYxDOCx2x/Index
>
There are some problems with using the TUSCANYxDOCx2x wiki space. It
doesnt seem to get built into the Tuscany website so links have to be
to cwiki.apache.org instead of tuscany.apache.org which the cwiki doc
says we shouldn't do. It also means that search engines don't index
the doc in the cwiki space which i think would really need to be fixed
if we're going to use it. And, I dont know how to say it other than
just saying it - IMHO TUSCANYxDOCx2x doesn't look very good, i know it
was done this way to try to get the automated PDF generation working
but its not consistent with the rest of the Tuscany website and it
doesn't look great.
...ant