You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@aries.apache.org by zoe <zo...@googlemail.com> on 2009/09/30 18:11:14 UTC

Aries wiki/website

Hi

I wonder if someone can help me out with a couple of questions about the 
wiki/website for Aries?

I was looking here http://incubator.apache.org/aries/ and clicked the 
edit button - which takes me to a cwiki page to edit, I can't do this 
yet because I don't have an account but it raised some questions.

1) If/when I edit the wiki how does it get exported to the web site? Is 
there a script somewhere?
2) Is the plan to retain things like 'edit' buttons on the project web 
site? If only committers can edit this doesn't seem desirable.

If there is some work to be done here I'd be very happy to help, but I 
need to understand more about the mechanism and what the intentions are 
for the project.

Thanks, Zoe







Re: Aries wiki/website - template

Posted by Donald Woods <dw...@apache.org>.
I can try updating the autoexport template to use the ServiceMix one if 
that is what everyone wants....  I have Confluence Admin rights :-)


-Donald


zoe wrote:
> Hi
> 
> ..snip
>> Right, the autoexport confluence plugin exports the web site 
>> automatically at
>>   http://cwiki.apache.org/ARIES/
>> It's actual location is:
>>    /www/confluence-exports/ARIES/
>>
>> This directory is simply rsynced to the aries web site using the
>> following cron job:
>> 0 * * * * (/usr/local/bin/rsync -r /www/confluence-exports/ARIES/
>> /www/incubator.apache.org/aries/)
>> So I don't think we can put anything in svn unfortunately.
>>   
> Indeed :-)
>>>
>>> OK - so what uses the template exactly? Is that something that the
>>> confluence plugin needs? And who has the ability to experiment with
>>> different templates, do you have to be a cwiki administrator? Do other
>>> projects have their templates in SVN?
>>>     
>>
>> Yes, most of the projects have their own template / style.
>> The template configuration can be changed from the following admin page:
>>    
>> http://cwiki.apache.org/confluence/admin/autoexport/configuration.action
>> Not sure what the permissions need to be to access / change this page 
>> though.
>>   
> Confluence admin permissions? Who has or could grant those?
>> There are a lot of apache web sites that work this way:
>>   * http://servicemix.apache.org
>>   * http://camel.apache.org
>>   * http://mina.apache.org
>>   * http://felix.apache.org
>>   * http://geronimo.apache.org
>>
>> I think most of those have the following components:
>>   * a header on top
>>   * a shortcut bar just below with links
>>   * a navigation bar on the left
>>   * the main content page in the center / bottom-right
>> All header / shortcuts / navigation are pages from confluence, so the
>> template is really basic, and all the styling is done using css.
>> If we agree, I can at least implement that, as it's mostly a copy /
>> paste thingy for the basic set up.
>>
>> I've included below the template for the servicemix web site.
>> If we agree, I can set this template for the web site, and the next
>> step would be to create an appropriate css for aries.
>> FWIW, css, javascripts and all are stored in the svn repo of servicemix:
>>     https://svn.apache.org/repos/asf/servicemix/site/
>> and we have an svn update in the cron job which looks like the following:
>>     (/usr/local/bin/rsync -r /www/confluence-exports/SM/
>> /www/servicemix.apache.org/ ; /usr/local/bin/svn update
>> /www/servicemix.apache.org/)
>>   
> +1 to using the same template as ServiceMix. I like the look and feel of 
> that site a lot, so if there are other parts that we can ... um  
> 're-purpose' .. that would get my vote too :-)
>>
>> ============================
>> ##
>> #macro (renderPage $title)
>>     #set($globalHelper = $action.getGlobalHelper())
>>     #set($renderer = $globalHelper.getWikiStyleRenderer())
>>     #foreach ($child in $page.space.pages)
>>         #if ($child.title.equals($title))
>>             #set ($content =
>> $renderer.convertWikiToXHtml($child.toPageContext(),
>> $child.content).trim())
>>             $content
>>         #end
>>     #end
>> #end
>> ##
>> #macro (renderMenuPage $title)
>>     #set($globalHelper = $action.getGlobalHelper())
>>     #set($renderer = $globalHelper.getWikiStyleRenderer())
>>     #foreach ($child in $page.space.pages)
>>         #if ($child.title.equals($title))
>>             #set ($content =
>> $renderer.convertWikiToXHtml($child.toPageContext(),
>> $child.content).trim())
>>             #set ($content =
>> $content.replaceAll("<LI>([^<]*\\S)(\\s*)<UL", "<li><div
>> onclick='SwitchMenu(this)'><h3>$1</h3>$2<ul"))
>>             #set ($content = $content.replaceAll("</UL>(\\s*)</LI>",
>> "</ul>$1</div></li>"))
>>             $content
>>         #end
>>     #end
>> #end
>> ##
>> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
>> "http://www.w3.org/TR/html4/loose.dtd">
>> <!--
>>
>>     Licensed to the Apache Software Foundation (ASF) under one or more
>>     contributor license agreements.  See the NOTICE file distributed with
>>     this work for additional information regarding copyright ownership.
>>     The ASF licenses this file to You under the Apache License, 
>> Version 2.0
>>     (the "License"); you may not use this file except in compliance with
>>     the License.  You may obtain a copy of the License at
>>
>>        http://www.apache.org/licenses/LICENSE-2.0
>>
>>     Unless required by applicable law or agreed to in writing, software
>>     distributed under the License is distributed on an "AS IS" BASIS,
>>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
>> implied.
>>     See the License for the specific language governing permissions and
>>     limitations under the License.
>> -->
>> <html>
>>   <head>
>>     <link type="text/css" rel="stylesheet"
>> href="http://servicemix.apache.org/resources/site.css"></link>
>>     <script src="http://servicemix.apache.org/resources/space.js"
>> type="text/javascript"></script>
>>     <script src="http://www.google-analytics.com/urchin.js"
>> type="text/javascript">
>>     </script>
>> <meta name="keywords" content="..."/>
>> <meta name="description" content="..." />
>>     <title>
>> Apache ServiceMix, the Agile Open Source ESB -- $page.title
>>     </title>
>>   </head>
>> <body onload="init()">
>>
>> <table width="100%" cellpadding="0" cellspacing="0">
>>   <tr width="100%">
>>     <td id="cell-0-0" colspan="2">&nbsp;</td>
>>     <td id="cell-0-1">&nbsp;</td>
>>     <td id="cell-0-2" colspan="2">&nbsp;</td>
>>   </tr>
>>   <tr width="100%">
>>     <td id="cell-1-0">&nbsp;</td>
>>     <td id="cell-1-1">&nbsp;</td>
>>     <td id="cell-1-2">
>>       <div style="padding: 5px;">
>>         <div id="banner">
>>           <!-- Banner -->
>> #renderPage("Banner")
>>           <!-- Banner -->
>>         </div>
>>       </div>
>>       <div id="top-menu">
>>         <table border="0" cellpadding="1" cellspacing="0" width="100%">
>>           <tr>
>>             <td>
>>               <div align="left">
>>                 <!-- Breadcrumbs -->
>> $autoexport.breadcrumbs($page)
>>                 <!-- Breadcrumbs -->
>>               </div>
>>             </td>
>>             <td>
>>               <div align="right">
>>                 <!-- Quicklinks -->
>> #renderPage("QuickLinks")
>>                 <!-- Quicklinks -->
>>               </div>
>>             </td>
>>           </tr>
>>         </table>
>>       </div>
>>     </td>
>>     <td id="cell-1-3">&nbsp;</td>
>>     <td id="cell-1-4">&nbsp;</td>
>>   </tr>
>>   <tr width="100%">
>>     <td id="cell-2-0" colspan="2">&nbsp;</td>
>>     <td id="cell-2-1">
>>       <table>
>>         <tr height="100%" valign="top">
>>           <td height="100%">
>>             <div id="wrapper-menu-page-right">
>>               <div id="wrapper-menu-page-top">
>>                 <div id="wrapper-menu-page-bottom">
>>                   <div id="menu-page">
>>                     <!-- NavigationBar -->
>> #renderPage("Navigation")
>>                 <!-- NavigationBar -->
>>               </div>
>>             </div>
>>           </div>
>>          </td>
>>          <td height="100%" width="100%">
>>            <!-- Content -->
>>            <div class="wiki-content">$body</div>
>>            <!-- Content -->
>>          </td>
>>         </tr>
>>       </table>
>>    </td>
>>    <td id="cell-2-2" colspan="2">&nbsp;</td>
>>   </tr>
>>   <tr width="100%">
>>    <td id="cell-3-0">&nbsp;</td>
>>    <td id="cell-3-1">&nbsp;</td>
>>    <td id="cell-3-2">
>>      <div id="footer">
>>        <!-- Footer -->
>>        <div id="site-footer">
>>          <a 
>> href="http://servicemix.apache.org/privacy-policy.html">Privacy
>> Policy</a> -
>>          #editReport()
>>          (<a 
>> href="$confluenceUri/pages/editpage.action?pageId=$page.id">edit
>> page</a>)
>>        </div>
>>        <!-- Footer -->
>>      </div>
>>    </td>
>>    <td id="cell-3-3">&nbsp;</td>
>>    <td id="cell-3-4">&nbsp;</td>
>>   </tr>
>>   <tr width="100%">
>>     <td id="cell-4-0" colspan="2">&nbsp;</td>
>>     <td id="cell-4-1">&nbsp;</td>
>>     <td id="cell-4-2" colspan="2">&nbsp;</td>
>>   </tr>
>> </table>
>>     <script type="text/javascript">
>> _uacct = "UA-398545-1";
>> urchinTracker();
>>     </script>
>> </body>
>> </html>
>>
>>
>>   
> 
> 

Re: Aries wiki/website

Posted by zoe <zo...@googlemail.com>.
Hi

..snip
> Right, the autoexport confluence plugin exports the web site automatically at
>   http://cwiki.apache.org/ARIES/
> It's actual location is:
>    /www/confluence-exports/ARIES/
>
> This directory is simply rsynced to the aries web site using the
> following cron job:
> 0 * * * * (/usr/local/bin/rsync -r /www/confluence-exports/ARIES/
> /www/incubator.apache.org/aries/)
> So I don't think we can put anything in svn unfortunately.
>   
Indeed :-)
>>
>> OK - so what uses the template exactly? Is that something that the
>> confluence plugin needs? And who has the ability to experiment with
>> different templates, do you have to be a cwiki administrator? Do other
>> projects have their templates in SVN?
>>     
>
> Yes, most of the projects have their own template / style.
> The template configuration can be changed from the following admin page:
>    http://cwiki.apache.org/confluence/admin/autoexport/configuration.action
> Not sure what the permissions need to be to access / change this page though.
>   
Confluence admin permissions? Who has or could grant those?
> There are a lot of apache web sites that work this way:
>   * http://servicemix.apache.org
>   * http://camel.apache.org
>   * http://mina.apache.org
>   * http://felix.apache.org
>   * http://geronimo.apache.org
>
> I think most of those have the following components:
>   * a header on top
>   * a shortcut bar just below with links
>   * a navigation bar on the left
>   * the main content page in the center / bottom-right
> All header / shortcuts / navigation are pages from confluence, so the
> template is really basic, and all the styling is done using css.
> If we agree, I can at least implement that, as it's mostly a copy /
> paste thingy for the basic set up.
>
> I've included below the template for the servicemix web site.
> If we agree, I can set this template for the web site, and the next
> step would be to create an appropriate css for aries.
> FWIW, css, javascripts and all are stored in the svn repo of servicemix:
>     https://svn.apache.org/repos/asf/servicemix/site/
> and we have an svn update in the cron job which looks like the following:
>     (/usr/local/bin/rsync -r /www/confluence-exports/SM/
> /www/servicemix.apache.org/ ; /usr/local/bin/svn update
> /www/servicemix.apache.org/)
>   
+1 to using the same template as ServiceMix. I like the look and feel of 
that site a lot, so if there are other parts that we can ... um  
're-purpose' .. that would get my vote too :-)
>
> ============================
> ##
> #macro (renderPage $title)
>     #set($globalHelper = $action.getGlobalHelper())
>     #set($renderer = $globalHelper.getWikiStyleRenderer())
>     #foreach ($child in $page.space.pages)
>         #if ($child.title.equals($title))
>             #set ($content =
> $renderer.convertWikiToXHtml($child.toPageContext(),
> $child.content).trim())
>             $content
>         #end
>     #end
> #end
> ##
> #macro (renderMenuPage $title)
>     #set($globalHelper = $action.getGlobalHelper())
>     #set($renderer = $globalHelper.getWikiStyleRenderer())
>     #foreach ($child in $page.space.pages)
>         #if ($child.title.equals($title))
>             #set ($content =
> $renderer.convertWikiToXHtml($child.toPageContext(),
> $child.content).trim())
>             #set ($content =
> $content.replaceAll("<LI>([^<]*\\S)(\\s*)<UL", "<li><div
> onclick='SwitchMenu(this)'><h3>$1</h3>$2<ul"))
>             #set ($content = $content.replaceAll("</UL>(\\s*)</LI>",
> "</ul>$1</div></li>"))
>             $content
>         #end
>     #end
> #end
> ##
> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
> "http://www.w3.org/TR/html4/loose.dtd">
> <!--
>
>     Licensed to the Apache Software Foundation (ASF) under one or more
>     contributor license agreements.  See the NOTICE file distributed with
>     this work for additional information regarding copyright ownership.
>     The ASF licenses this file to You under the Apache License, Version 2.0
>     (the "License"); you may not use this file except in compliance with
>     the License.  You may obtain a copy of the License at
>
>        http://www.apache.org/licenses/LICENSE-2.0
>
>     Unless required by applicable law or agreed to in writing, software
>     distributed under the License is distributed on an "AS IS" BASIS,
>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
>     See the License for the specific language governing permissions and
>     limitations under the License.
> -->
> <html>
>   <head>
>     <link type="text/css" rel="stylesheet"
> href="http://servicemix.apache.org/resources/site.css"></link>
>     <script src="http://servicemix.apache.org/resources/space.js"
> type="text/javascript"></script>
>     <script src="http://www.google-analytics.com/urchin.js"
> type="text/javascript">
>     </script>
> <meta name="keywords" content="..."/>
> <meta name="description" content="..." />
>     <title>
> Apache ServiceMix, the Agile Open Source ESB -- $page.title
>     </title>
>   </head>
> <body onload="init()">
>
> <table width="100%" cellpadding="0" cellspacing="0">
>   <tr width="100%">
>     <td id="cell-0-0" colspan="2">&nbsp;</td>
>     <td id="cell-0-1">&nbsp;</td>
>     <td id="cell-0-2" colspan="2">&nbsp;</td>
>   </tr>
>   <tr width="100%">
>     <td id="cell-1-0">&nbsp;</td>
>     <td id="cell-1-1">&nbsp;</td>
>     <td id="cell-1-2">
>       <div style="padding: 5px;">
>         <div id="banner">
>           <!-- Banner -->
> #renderPage("Banner")
>           <!-- Banner -->
>         </div>
>       </div>
>       <div id="top-menu">
>         <table border="0" cellpadding="1" cellspacing="0" width="100%">
>           <tr>
>             <td>
>               <div align="left">
>                 <!-- Breadcrumbs -->
> $autoexport.breadcrumbs($page)
>                 <!-- Breadcrumbs -->
>               </div>
>             </td>
>             <td>
>               <div align="right">
>                 <!-- Quicklinks -->
> #renderPage("QuickLinks")
>                 <!-- Quicklinks -->
>               </div>
>             </td>
>           </tr>
>         </table>
>       </div>
>     </td>
>     <td id="cell-1-3">&nbsp;</td>
>     <td id="cell-1-4">&nbsp;</td>
>   </tr>
>   <tr width="100%">
>     <td id="cell-2-0" colspan="2">&nbsp;</td>
>     <td id="cell-2-1">
>       <table>
>         <tr height="100%" valign="top">
>           <td height="100%">
>             <div id="wrapper-menu-page-right">
>               <div id="wrapper-menu-page-top">
>                 <div id="wrapper-menu-page-bottom">
>                   <div id="menu-page">
>                     <!-- NavigationBar -->
> #renderPage("Navigation")
>                 <!-- NavigationBar -->
>               </div>
>             </div>
>           </div>
>          </td>
>          <td height="100%" width="100%">
>            <!-- Content -->
>            <div class="wiki-content">$body</div>
>            <!-- Content -->
>          </td>
>         </tr>
>       </table>
>    </td>
>    <td id="cell-2-2" colspan="2">&nbsp;</td>
>   </tr>
>   <tr width="100%">
>    <td id="cell-3-0">&nbsp;</td>
>    <td id="cell-3-1">&nbsp;</td>
>    <td id="cell-3-2">
>      <div id="footer">
>        <!-- Footer -->
>        <div id="site-footer">
>          <a href="http://servicemix.apache.org/privacy-policy.html">Privacy
> Policy</a> -
>          #editReport()
>          (<a href="$confluenceUri/pages/editpage.action?pageId=$page.id">edit
> page</a>)
>        </div>
>        <!-- Footer -->
>      </div>
>    </td>
>    <td id="cell-3-3">&nbsp;</td>
>    <td id="cell-3-4">&nbsp;</td>
>   </tr>
>   <tr width="100%">
>     <td id="cell-4-0" colspan="2">&nbsp;</td>
>     <td id="cell-4-1">&nbsp;</td>
>     <td id="cell-4-2" colspan="2">&nbsp;</td>
>   </tr>
> </table>
>     <script type="text/javascript">
> _uacct = "UA-398545-1";
> urchinTracker();
>     </script>
> </body>
> </html>
>
>
>   


Re: Aries wiki/website

Posted by Donald Woods <dw...@apache.org>.
The only item I found in the sling export so far (which all the exported 
spaces have) is -
    /www/confluence-exports/SLING/resources/space.css
which looks like the standard CSS from Confluence without any license 
info included.

It looks like for images, the pages are just referring back to the 
Confluence hosted files instead of copying them, like index.html -
http://cwiki.apache.org/confluence/images/border/border_bottom.gif

So, I think we'd be okay to check-in the files.  Guess our 
Geronimo/OpenJPA www areas have stale copies of the Confluence images 
due to an older autoexport plugin copying them over during the space 
export....


-Donald


Bertrand Delacretaz wrote:
> On Thu, Oct 8, 2009 at 4:25 PM, Donald Woods <dw...@apache.org> wrote:
>> Should there be any concern for checking in the images and css files that
>> the autoexport plugin is pulling from Confluence?  There are a lot of images
>> that get included in the exported space that come directly from the
>> Confluence installation....
> 
> Licensing concerns you mean?
> 
> http://sling.apache.org/ is generated from Confluence, using a custom
> template, do you think it contains anything that could belong to
> Confluence license-wise?
> 
> -Bertrand
> 
>> For Geronimo and OpenJPA, we still rsync the files over and keep custom
>> logos/graphics in svn (along with backup copies of the custom autoexport
>> template) and just manually copy them over when they change.
>>
>>
>> -Donald
>>
>>
>> Bertrand Delacretaz wrote:
>>> Hi,
>>>
>>> On Wed, Oct 7, 2009 at 3:50 PM, Guillaume Nodet <gn...@gmail.com> wrote:
>>>> ...the autoexport confluence plugin exports the web site automatically at
>>>>  http://cwiki.apache.org/ARIES/
>>>> It's actual location is:
>>>>  /www/confluence-exports/ARIES/
>>>>
>>>> This directory is simply rsynced to the aries web site using the
>>>> following cron job:
>>>> 0 * * * * (/usr/local/bin/rsync -r /www/confluence-exports/ARIES/
>>>> /www/incubator.apache.org/aries/)
>>>> So I don't think we can put anything in svn unfortunately....
>>> There would be a way to have the website in svn:
>>>
>>> 1. Let autoexport generate site at /www/confluence-exports/ARIES (or
>>> trigger it)
>>> 2. Aries committer rsyncs that folder to their local svn workspace and
>>> reviews
>>> 3. Commiter commits, and svnpubsub [1] quickly copies content to live
>>> website (setup by infra)
>>>
>>> Compared to the current setup, all the content is in svn, which makes
>>> it easier to post-process or mix that content with generated content
>>> (javadocs etc). The activation to the live site is also very quick,
>>> compared to scheduled currently. The downside is step 2. above.
>>>
>>> -Bertrand
>>>
>>> [1]
>>> https://svn.apache.org/repos/infra/infrastructure/trunk/projects/svnpubsub/svnpubsub.py
>>>
> 

Re: Aries wiki/website

Posted by Bertrand Delacretaz <bd...@apache.org>.
On Thu, Oct 8, 2009 at 4:25 PM, Donald Woods <dw...@apache.org> wrote:
> Should there be any concern for checking in the images and css files that
> the autoexport plugin is pulling from Confluence?  There are a lot of images
> that get included in the exported space that come directly from the
> Confluence installation....

Licensing concerns you mean?

http://sling.apache.org/ is generated from Confluence, using a custom
template, do you think it contains anything that could belong to
Confluence license-wise?

-Bertrand

>
> For Geronimo and OpenJPA, we still rsync the files over and keep custom
> logos/graphics in svn (along with backup copies of the custom autoexport
> template) and just manually copy them over when they change.
>
>
> -Donald
>
>
> Bertrand Delacretaz wrote:
>>
>> Hi,
>>
>> On Wed, Oct 7, 2009 at 3:50 PM, Guillaume Nodet <gn...@gmail.com> wrote:
>>>
>>> ...the autoexport confluence plugin exports the web site automatically at
>>>  http://cwiki.apache.org/ARIES/
>>> It's actual location is:
>>>  /www/confluence-exports/ARIES/
>>>
>>> This directory is simply rsynced to the aries web site using the
>>> following cron job:
>>> 0 * * * * (/usr/local/bin/rsync -r /www/confluence-exports/ARIES/
>>> /www/incubator.apache.org/aries/)
>>> So I don't think we can put anything in svn unfortunately....
>>
>> There would be a way to have the website in svn:
>>
>> 1. Let autoexport generate site at /www/confluence-exports/ARIES (or
>> trigger it)
>> 2. Aries committer rsyncs that folder to their local svn workspace and
>> reviews
>> 3. Commiter commits, and svnpubsub [1] quickly copies content to live
>> website (setup by infra)
>>
>> Compared to the current setup, all the content is in svn, which makes
>> it easier to post-process or mix that content with generated content
>> (javadocs etc). The activation to the live site is also very quick,
>> compared to scheduled currently. The downside is step 2. above.
>>
>> -Bertrand
>>
>> [1]
>> https://svn.apache.org/repos/infra/infrastructure/trunk/projects/svnpubsub/svnpubsub.py
>>
>

Re: Aries wiki/website

Posted by Donald Woods <dw...@apache.org>.
Should there be any concern for checking in the images and css files 
that the autoexport plugin is pulling from Confluence?  There are a lot 
of images that get included in the exported space that come directly 
from the Confluence installation....

For Geronimo and OpenJPA, we still rsync the files over and keep custom 
logos/graphics in svn (along with backup copies of the custom autoexport 
template) and just manually copy them over when they change.


-Donald


Bertrand Delacretaz wrote:
> Hi,
> 
> On Wed, Oct 7, 2009 at 3:50 PM, Guillaume Nodet <gn...@gmail.com> wrote:
>> ...the autoexport confluence plugin exports the web site automatically at
>>  http://cwiki.apache.org/ARIES/
>> It's actual location is:
>>   /www/confluence-exports/ARIES/
>>
>> This directory is simply rsynced to the aries web site using the
>> following cron job:
>> 0 * * * * (/usr/local/bin/rsync -r /www/confluence-exports/ARIES/
>> /www/incubator.apache.org/aries/)
>> So I don't think we can put anything in svn unfortunately....
> 
> There would be a way to have the website in svn:
> 
> 1. Let autoexport generate site at /www/confluence-exports/ARIES (or trigger it)
> 2. Aries committer rsyncs that folder to their local svn workspace and reviews
> 3. Commiter commits, and svnpubsub [1] quickly copies content to live
> website (setup by infra)
> 
> Compared to the current setup, all the content is in svn, which makes
> it easier to post-process or mix that content with generated content
> (javadocs etc). The activation to the live site is also very quick,
> compared to scheduled currently. The downside is step 2. above.
> 
> -Bertrand
> 
> [1] https://svn.apache.org/repos/infra/infrastructure/trunk/projects/svnpubsub/svnpubsub.py
> 

Re: Aries wiki/website

Posted by Bertrand Delacretaz <bd...@apache.org>.
Hi,

On Wed, Oct 7, 2009 at 3:50 PM, Guillaume Nodet <gn...@gmail.com> wrote:
> ...the autoexport confluence plugin exports the web site automatically at
>  http://cwiki.apache.org/ARIES/
> It's actual location is:
>   /www/confluence-exports/ARIES/
>
> This directory is simply rsynced to the aries web site using the
> following cron job:
> 0 * * * * (/usr/local/bin/rsync -r /www/confluence-exports/ARIES/
> /www/incubator.apache.org/aries/)
> So I don't think we can put anything in svn unfortunately....

There would be a way to have the website in svn:

1. Let autoexport generate site at /www/confluence-exports/ARIES (or trigger it)
2. Aries committer rsyncs that folder to their local svn workspace and reviews
3. Commiter commits, and svnpubsub [1] quickly copies content to live
website (setup by infra)

Compared to the current setup, all the content is in svn, which makes
it easier to post-process or mix that content with generated content
(javadocs etc). The activation to the live site is also very quick,
compared to scheduled currently. The downside is step 2. above.

-Bertrand

[1] https://svn.apache.org/repos/infra/infrastructure/trunk/projects/svnpubsub/svnpubsub.py

Re: Aries wiki/website

Posted by Guillaume Nodet <gn...@gmail.com>.
On Wed, Oct 7, 2009 at 15:32, zoe <zo...@googlemail.com> wrote:
> Hi Guillaume - a lot more questions :-) Please feel free to point me at
> somewhere this is all written down, I'm afraid I just couldn't find it.
>>>
>>> 1) If/when I edit the wiki how does it get exported to the web site? Is
>>> there a script somewhere?
>>>
>>
>> The wiki pages are automatically exported into html.  The result is
>> rsynced to the web site using a cron job i've set up.
>>
>
> Great. So am I right in thinking that there is a a confluence plugin that
> automatically stages content to somewhere that people can (for example)
> review changes? And then your script rsyncs that location (where is it?) to
> the website? Is it usual to put this kind of script in SVN?

Right, the autoexport confluence plugin exports the web site automatically at
  http://cwiki.apache.org/ARIES/
It's actual location is:
   /www/confluence-exports/ARIES/

This directory is simply rsynced to the aries web site using the
following cron job:
0 * * * * (/usr/local/bin/rsync -r /www/confluence-exports/ARIES/
/www/incubator.apache.org/aries/)
So I don't think we can put anything in svn unfortunately.


>>
>>
>>>
>>> 2) Is the plan to retain things like 'edit' buttons on the project web
>>> site?
>>> If only committers can edit this doesn't seem desirable.
>>>
>>
>> Agreed.  But we'll have to design a better template to do that.  There
>> are lots of those available from other Apache projects, so we can
>> start with one of those and modify it.
>>
>>
>
> OK - so what uses the template exactly? Is that something that the
> confluence plugin needs? And who has the ability to experiment with
> different templates, do you have to be a cwiki administrator? Do other
> projects have their templates in SVN?

Yes, most of the projects have their own template / style.
The template configuration can be changed from the following admin page:
   http://cwiki.apache.org/confluence/admin/autoexport/configuration.action
Not sure what the permissions need to be to access / change this page though.

There are a lot of apache web sites that work this way:
  * http://servicemix.apache.org
  * http://camel.apache.org
  * http://mina.apache.org
  * http://felix.apache.org
  * http://geronimo.apache.org

I think most of those have the following components:
  * a header on top
  * a shortcut bar just below with links
  * a navigation bar on the left
  * the main content page in the center / bottom-right
All header / shortcuts / navigation are pages from confluence, so the
template is really basic, and all the styling is done using css.
If we agree, I can at least implement that, as it's mostly a copy /
paste thingy for the basic set up.

I've included below the template for the servicemix web site.
If we agree, I can set this template for the web site, and the next
step would be to create an appropriate css for aries.
FWIW, css, javascripts and all are stored in the svn repo of servicemix:
    https://svn.apache.org/repos/asf/servicemix/site/
and we have an svn update in the cron job which looks like the following:
    (/usr/local/bin/rsync -r /www/confluence-exports/SM/
/www/servicemix.apache.org/ ; /usr/local/bin/svn update
/www/servicemix.apache.org/)


============================
##
#macro (renderPage $title)
    #set($globalHelper = $action.getGlobalHelper())
    #set($renderer = $globalHelper.getWikiStyleRenderer())
    #foreach ($child in $page.space.pages)
        #if ($child.title.equals($title))
            #set ($content =
$renderer.convertWikiToXHtml($child.toPageContext(),
$child.content).trim())
            $content
        #end
    #end
#end
##
#macro (renderMenuPage $title)
    #set($globalHelper = $action.getGlobalHelper())
    #set($renderer = $globalHelper.getWikiStyleRenderer())
    #foreach ($child in $page.space.pages)
        #if ($child.title.equals($title))
            #set ($content =
$renderer.convertWikiToXHtml($child.toPageContext(),
$child.content).trim())
            #set ($content =
$content.replaceAll("<LI>([^<]*\\S)(\\s*)<UL", "<li><div
onclick='SwitchMenu(this)'><h3>$1</h3>$2<ul"))
            #set ($content = $content.replaceAll("</UL>(\\s*)</LI>",
"</ul>$1</div></li>"))
            $content
        #end
    #end
#end
##
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<!--

    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
    this work for additional information regarding copyright ownership.
    The ASF licenses this file to You under the Apache License, Version 2.0
    (the "License"); you may not use this file except in compliance with
    the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-->
<html>
  <head>
    <link type="text/css" rel="stylesheet"
href="http://servicemix.apache.org/resources/site.css"></link>
    <script src="http://servicemix.apache.org/resources/space.js"
type="text/javascript"></script>
    <script src="http://www.google-analytics.com/urchin.js"
type="text/javascript">
    </script>
<meta name="keywords" content="..."/>
<meta name="description" content="..." />
    <title>
Apache ServiceMix, the Agile Open Source ESB -- $page.title
    </title>
  </head>
<body onload="init()">

<table width="100%" cellpadding="0" cellspacing="0">
  <tr width="100%">
    <td id="cell-0-0" colspan="2">&nbsp;</td>
    <td id="cell-0-1">&nbsp;</td>
    <td id="cell-0-2" colspan="2">&nbsp;</td>
  </tr>
  <tr width="100%">
    <td id="cell-1-0">&nbsp;</td>
    <td id="cell-1-1">&nbsp;</td>
    <td id="cell-1-2">
      <div style="padding: 5px;">
        <div id="banner">
          <!-- Banner -->
#renderPage("Banner")
          <!-- Banner -->
        </div>
      </div>
      <div id="top-menu">
        <table border="0" cellpadding="1" cellspacing="0" width="100%">
          <tr>
            <td>
              <div align="left">
                <!-- Breadcrumbs -->
$autoexport.breadcrumbs($page)
                <!-- Breadcrumbs -->
              </div>
            </td>
            <td>
              <div align="right">
                <!-- Quicklinks -->
#renderPage("QuickLinks")
                <!-- Quicklinks -->
              </div>
            </td>
          </tr>
        </table>
      </div>
    </td>
    <td id="cell-1-3">&nbsp;</td>
    <td id="cell-1-4">&nbsp;</td>
  </tr>
  <tr width="100%">
    <td id="cell-2-0" colspan="2">&nbsp;</td>
    <td id="cell-2-1">
      <table>
        <tr height="100%" valign="top">
          <td height="100%">
            <div id="wrapper-menu-page-right">
              <div id="wrapper-menu-page-top">
                <div id="wrapper-menu-page-bottom">
                  <div id="menu-page">
                    <!-- NavigationBar -->
#renderPage("Navigation")
                <!-- NavigationBar -->
              </div>
            </div>
          </div>
         </td>
         <td height="100%" width="100%">
           <!-- Content -->
           <div class="wiki-content">$body</div>
           <!-- Content -->
         </td>
        </tr>
      </table>
   </td>
   <td id="cell-2-2" colspan="2">&nbsp;</td>
  </tr>
  <tr width="100%">
   <td id="cell-3-0">&nbsp;</td>
   <td id="cell-3-1">&nbsp;</td>
   <td id="cell-3-2">
     <div id="footer">
       <!-- Footer -->
       <div id="site-footer">
         <a href="http://servicemix.apache.org/privacy-policy.html">Privacy
Policy</a> -
         #editReport()
         (<a href="$confluenceUri/pages/editpage.action?pageId=$page.id">edit
page</a>)
       </div>
       <!-- Footer -->
     </div>
   </td>
   <td id="cell-3-3">&nbsp;</td>
   <td id="cell-3-4">&nbsp;</td>
  </tr>
  <tr width="100%">
    <td id="cell-4-0" colspan="2">&nbsp;</td>
    <td id="cell-4-1">&nbsp;</td>
    <td id="cell-4-2" colspan="2">&nbsp;</td>
  </tr>
</table>
    <script type="text/javascript">
_uacct = "UA-398545-1";
urchinTracker();
    </script>
</body>
</html>


-- 
Cheers,
Guillaume Nodet
------------------------
Blog: http://gnodet.blogspot.com/
------------------------
Open Source SOA
http://fusesource.com

Re: Aries wiki/website

Posted by zoe <zo...@googlemail.com>.
Hi Guillaume - a lot more questions :-) Please feel free to point me at 
somewhere this is all written down, I'm afraid I just couldn't find it.
>>
>> 1) If/when I edit the wiki how does it get exported to the web site? Is
>> there a script somewhere?
>>     
>
> The wiki pages are automatically exported into html.  The result is
> rsynced to the web site using a cron job i've set up.
>   
Great. So am I right in thinking that there is a a confluence plugin 
that automatically stages content to somewhere that people can (for 
example) review changes? And then your script rsyncs that location 
(where is it?) to the website? Is it usual to put this kind of script in 
SVN?
>   
>> 2) Is the plan to retain things like 'edit' buttons on the project web site?
>> If only committers can edit this doesn't seem desirable.
>>     
>
> Agreed.  But we'll have to design a better template to do that.  There
> are lots of those available from other Apache projects, so we can
> start with one of those and modify it.
>
>   
OK - so what uses the template exactly? Is that something that the 
confluence plugin needs? And who has the ability to experiment with 
different templates, do you have to be a cwiki administrator? Do other 
projects have their templates in SVN?

Zoe




Re: Aries wiki/website

Posted by Guillaume Nodet <gn...@gmail.com>.
On Wed, Sep 30, 2009 at 18:11, zoe <zo...@googlemail.com> wrote:
> Hi
>
> I wonder if someone can help me out with a couple of questions about the
> wiki/website for Aries?
>
> I was looking here http://incubator.apache.org/aries/ and clicked the edit
> button - which takes me to a cwiki page to edit, I can't do this yet because
> I don't have an account but it raised some questions.
>
> 1) If/when I edit the wiki how does it get exported to the web site? Is
> there a script somewhere?

The wiki pages are automatically exported into html.  The result is
rsynced to the web site using a cron job i've set up.

> 2) Is the plan to retain things like 'edit' buttons on the project web site?
> If only committers can edit this doesn't seem desirable.

Agreed.  But we'll have to design a better template to do that.  There
are lots of those available from other Apache projects, so we can
start with one of those and modify it.

> If there is some work to be done here I'd be very happy to help, but I need
> to understand more about the mechanism and what the intentions are for the
> project.
>
> Thanks, Zoe
>
>
>
>
>
>
>



-- 
Cheers,
Guillaume Nodet
------------------------
Blog: http://gnodet.blogspot.com/
------------------------
Open Source SOA
http://fusesource.com