You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by cm...@apache.org on 2012/09/13 14:17:54 UTC

svn commit: r1384295 - in /incubator/deltaspike/site/trunk: content/deltaspike/ lib/

Author: cmoulliard
Date: Thu Sep 13 12:17:53 2012
New Revision: 1384295

URL: http://svn.apache.org/viewvc?rev=1384295&view=rev
Log:
Modify source page, view and path.vm to allow to use {include:} instructions

Added:
    incubator/deltaspike/site/trunk/content/deltaspike/new-committer.mdtext
Modified:
    incubator/deltaspike/site/trunk/content/deltaspike/community.mdtext
    incubator/deltaspike/site/trunk/content/deltaspike/source.mdtext
    incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext
    incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext
    incubator/deltaspike/site/trunk/lib/path.pm
    incubator/deltaspike/site/trunk/lib/view.pm

Modified: incubator/deltaspike/site/trunk/content/deltaspike/community.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/community.mdtext?rev=1384295&r1=1384294&r2=1384295&view=diff
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/community.mdtext (original)
+++ incubator/deltaspike/site/trunk/content/deltaspike/community.mdtext Thu Sep 13 12:17:53 2012
@@ -18,7 +18,8 @@ Notice:    Licensed to the Apache Softwa
 
 # Users
 
-If you are a new user and you would like to start using DeltaSpike, you can have a look at the [Documentation](documentation.html) and [subscribe](mailto:deltaspike-users-subscribe@incubator.apache.org) our [mailing list for users](mailto:deltaspike-users@incubator.apache.org). If you have troubles to find the information you are looking for, you can also ask in our [IRC-Channel](http://people.apache.org/~gpetracek/deltaspike/freenode.html).
+If you are a new user and you would like to start using DeltaSpike, you can have a look at the [Documentation](documentation.html) and [subscribe](mailto:deltaspike-users-subscribe@incubator.apache.org) our [mailing list for users](mailto:deltaspike-users@incubator.apache.org).
+If you have troubles to find the information you are looking for, you can also ask in our [IRC-Channel](http://people.apache.org/~gpetracek/deltaspike/freenode.html).
 
 Furthermore, you can check our [mail-archive](http://mail-archives.apache.org/mod_mbox/incubator-deltaspike-users/) (mirrors are available at: [MarkMail](http://markmail.org/search/?q=list%3Aorg.apache.incubator.deltaspike-users+order%3Adate-backward)).
 
@@ -42,135 +43,8 @@ Furthermore, you can check our [mail-arc
 
 Further details are available at [http://www.apache.org/dev/](http://www.apache.org/dev/).
 
-## VCS / Repository
+Procedure to become a new [committer](new-commiter)
 
-We are using GIT and there is a *read-only* [GitHub mirror](https://github.com/apache/incubator-deltaspike). Furthermore, we follow an unified [GIT workflow](https://cwiki.apache.org/confluence/display/DeltaSpike/Suggested+Git+Workflows) to keep the commit history straight and therefore simple and clean.
-General details about GIT at Apache are available [here](http://wiki.apache.org/couchdb/Git_At_Apache_Guide) and at [http://git-wip-us.apache.org](http://git-wip-us.apache.org).
+# Supporters
 
-Our GIT repository is at [https://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git](https://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git) (see also [https://git-wip-us.apache.org/repos/asf](https://git-wip-us.apache.org/repos/asf))
-
-    //initial 'checkout':
-    git clone https://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git
-
-    //update of an existing clone which might contain changes
-    git pull --rebase
-
-## Invitation to become a project Committer
-As soon as the PPMC is confident that you are a great addition to the team, one of the PPMC members starts an internal vote.
-
-# (P)PMC
-
-## Votes
-
-To: private list
-CC: private incubator list
-
-    [VOTE] ... becoming a committer
-
-    Hi,
-
-    over the past weeks, ... [reason for the suggestion]
-
-    Therefore I'd like to vote ... in as a committer!
-
-    The options for the vote are:
-    [+1] get him on board
-    [+0] don't care
-    [-1] nope, because... (fill in)
-
-    The vote is open for 72h.
-
-    Regards,
-    ...
-
-
-After 72 hours
-To: private list
-
-
-    Result (was: Re: [VOTE] ... becoming a committer)
-
-    thank you for voting!
-
-    the vote passed with the following result:
-
-    +1:
-    ...
-
-    +0:
-    ...
-
-    -1:
-    ...
-
-
-    Regards,
-    ...
-
-In case of a PPMC vote it's required that a IPMC member sends a lazy consensus vote to the private incubator list. That isn't required for top-level projects.
-
-To: private incubator list
-
-    [VOTE] Invite ... to become a DeltaSpike Committer
-
-    The DeltaSpike PPMC has completed a vote to invite ... to
-    become a project committer.
-
-    The vote [1] passed with the following +1 votes  from IPMC members:
-    ...
-    and ... +0 and ... -1 votes. So this is a 72 hour lazy consensus vote.
-
-    Thanks & regards,
-    ...
-
-    [1] ...
-
-It isn't required to do so, but usually the person who started also sends the invitation.
-
-CC: the private list
-
-    [INVITATION] to become an Apache DeltaSpike committer
-
-    Dear ...,
-
-    On behalf of the Apache DeltaSpike PPMC, I would like to extend an
-    invitation to become a DeltaSpike Committer. If you might be interested,
-    please be sure to review the How the ASF Works pages.
-
-    * http://apache.org/foundation/how-it-works.html
-    * http://incubator.apache.org/guides/committer.html
-
-    If you decide to accept the invitation, the first step would be to
-    file an Individual Contributor License Agreement (if you haven't done
-    so already). If you have an intellectual property agreement with your
-    employer, they may also need to file a corporate agreement
-
-    * http://apache.org/licenses/cla-corporate.txt
-
-    The next step would be to send your first three choices for an
-    Apache account name (special characters aren't supported).
-    Once the account is setup, you will be able to
-    commit to the DeltaSpike repository.
-
-    We do hope that you will be able to join us. And, we do thank you for
-    your sustained efforts in helping us build not only great software,
-    but a great community.
-
-    Regards,
-    ...
-
-Send an [account request|http://id.apache.org/acreq] and announce the new community member if s/he accepted.
-
-    [COMMUNITY] DeltaSpike += ...
-
-    The DeltaSpike PPMC is proud to announce a new addition to our community.
-
-    Please welcome ... as the newest DeltaSpike committer!
-
-    @...: Please ensure you understand our workflow [1] and add yourself to the Parent-POM [2].
-
-    Welcome & regards,
-    Gerhard
-
-    [1] https://cwiki.apache.org/confluence/display/DeltaSpike/Suggested+Git+Workflows
-    [2] http://s.apache.org/deltaspike_parent-pom
\ No newline at end of file
+{include:deltaspike/supporters.mdtext}
\ No newline at end of file

Added: incubator/deltaspike/site/trunk/content/deltaspike/new-committer.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/new-committer.mdtext?rev=1384295&view=auto
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/new-committer.mdtext (added)
+++ incubator/deltaspike/site/trunk/content/deltaspike/new-committer.mdtext Thu Sep 13 12:17:53 2012
@@ -0,0 +1,138 @@
+Title: New Committer
+Notice:    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.
+
+## Invitation to become a project Committer
+
+As soon as the PPMC is confident that you are a great addition to the team, one of the PPMC members starts an internal vote.
+
+# (P)PMC
+
+## Votes
+
+To: private list
+CC: private incubator list
+
+    [VOTE] ... becoming a committer
+
+    Hi,
+
+    over the past weeks, ... [reason for the suggestion]
+
+    Therefore I'd like to vote ... in as a committer!
+
+    The options for the vote are:
+    [+1] get him on board
+    [+0] don't care
+    [-1] nope, because... (fill in)
+
+    The vote is open for 72h.
+
+    Regards,
+    ...
+
+
+After 72 hours
+To: private list
+
+
+    Result (was: Re: [VOTE] ... becoming a committer)
+
+    thank you for voting!
+
+    the vote passed with the following result:
+
+    +1:
+    ...
+
+    +0:
+    ...
+
+    -1:
+    ...
+
+
+    Regards,
+    ...
+
+In case of a PPMC vote it's required that a IPMC member sends a lazy consensus vote to the private incubator list. That isn't required for top-level projects.
+
+To: private incubator list
+
+    [VOTE] Invite ... to become a DeltaSpike Committer
+
+    The DeltaSpike PPMC has completed a vote to invite ... to
+    become a project committer.
+
+    The vote [1] passed with the following +1 votes  from IPMC members:
+    ...
+    and ... +0 and ... -1 votes. So this is a 72 hour lazy consensus vote.
+
+    Thanks & regards,
+    ...
+
+    [1] ...
+
+It isn't required to do so, but usually the person who started also sends the invitation.
+
+CC: the private list
+
+    [INVITATION] to become an Apache DeltaSpike committer
+
+    Dear ...,
+
+    On behalf of the Apache DeltaSpike PPMC, I would like to extend an
+    invitation to become a DeltaSpike Committer. If you might be interested,
+    please be sure to review the How the ASF Works pages.
+
+    * http://apache.org/foundation/how-it-works.html
+    * http://incubator.apache.org/guides/committer.html
+
+    If you decide to accept the invitation, the first step would be to
+    file an Individual Contributor License Agreement (if you haven't done
+    so already). If you have an intellectual property agreement with your
+    employer, they may also need to file a corporate agreement
+
+    * http://apache.org/licenses/cla-corporate.txt
+
+    The next step would be to send your first three choices for an
+    Apache account name (special characters aren't supported).
+    Once the account is setup, you will be able to
+    commit to the DeltaSpike repository.
+
+    We do hope that you will be able to join us. And, we do thank you for
+    your sustained efforts in helping us build not only great software,
+    but a great community.
+
+    Regards,
+    ...
+
+Send an [account request|http://id.apache.org/acreq] and announce the new community member if s/he accepted.
+
+    [COMMUNITY] DeltaSpike += ...
+
+    The DeltaSpike PPMC is proud to announce a new addition to our community.
+
+    Please welcome ... as the newest DeltaSpike committer!
+
+    @...: Please ensure you understand our workflow [1] and add yourself to the Parent-POM [2].
+
+    Welcome & regards,
+    Gerhard
+
+    [1] https://cwiki.apache.org/confluence/display/DeltaSpike/Suggested+Git+Workflows
+    [2] http://s.apache.org/deltaspike_parent-pom
\ No newline at end of file

Modified: incubator/deltaspike/site/trunk/content/deltaspike/source.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/source.mdtext?rev=1384295&r1=1384294&r2=1384295&view=diff
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/source.mdtext (original)
+++ incubator/deltaspike/site/trunk/content/deltaspike/source.mdtext Thu Sep 13 12:17:53 2012
@@ -18,11 +18,21 @@ Notice:    Licensed to the Apache Softwa
 
 # Source Repository
 
-The source code is in a Apache Git repository hosted on github at this Web location:
+We are using GIT and the *READ-ONLY* source code is hosted on github at this location:
 
 * [https://github.com/apache/incubator-deltaspike](https://github.com/apache/incubator-deltaspike)
 
-If you are new to Git you might like to try the [Git guide for subversion users](http://git.or.cz/course/svn.html) or have a look at the [Git community book](http://git-scm.com/book).
+The official GIT repository of the project is available here :
+
+* [https://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git](https://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git)
+
+For other Apache projects, see also [https://git-wip-us.apache.org/repos/asf](https://git-wip-us.apache.org/repos/asf))
+
+Remarks :
+
+- If you are new to Git you might like to try the [Git guide for subversion users](http://git.or.cz/course/svn.html) or have a look at the [Git community book](http://git-scm.com/book).
+- We follow an unified [GIT workflow](suggested-git-workflows.html) to keep the commit history straight and therefore simple and clean.
+  General details about GIT at Apache are available [here](http://wiki.apache.org/couchdb/Git_At_Apache_Guide) and at [http://git-wip-us.apache.org](http://git-wip-us.apache.org).
 
  
 # How to checkout the code
@@ -30,18 +40,23 @@ If you are new to Git you might like to 
  
 ## Anonymous users
 
-Users can download the code source from GitHub repository using the following url and git clone instruction. More information about URL to be used can be find [here](https://help.github.com/articles/which-remote-url-should-i-use)
+Users can download the code source from GitHub repository or Apache Git using the following urls and git clone instruction.
+More information about URL to be used can be find [here](https://help.github.com/articles/which-remote-url-should-i-use)
+
+    // GitHub
+    git clone https://github.com/apache/incubator-deltaspike.git
+
+  
 
-    git clone git://github.com/apache/incubator-deltaspike.git
-    cd incubator-deltaspike
+    // Apache Git
+    git clone http://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git
 
  
 ## Members
 
 The members of DeltaSpike project which are also committers and contributers will use a different URL address
 
-    git clone https://github.com/apache/incubator-deltaspike
-    cd incubator-deltaspike
+    git clone https://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git
 
  
 # Build

Modified: incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext?rev=1384295&r1=1384294&r2=1384295&view=diff
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext (original)
+++ incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext Thu Sep 13 12:17:53 2012
@@ -18,17 +18,17 @@ Notice:    Licensed to the Apache Softwa
 
 Apache DeltaSpike gets support from many community members.
 
-# Git Mirrors
+## Git Mirrors
 
 Besides the official GitHub mirror there are the following mirrors:
- * https://github.com/DeltaSpike/Mirror (+ the corresponding internal [Irian|http://www.irian.at] mirror for the sync.)
+ * https://github.com/DeltaSpike/Mirror (+ the corresponding internal [Irian](http://www.irian.at) mirror for the sync.)
 
-# Mailing-list Mirrors
+## Mailing-list Mirrors
 
- * [Markmail|http://incubator.markmail.org/search/?q=list%3Aorg.apache.incubator.deltaspike-dev]
- * [Nabble|https://s.apache.org/deltaspike-dev_nabble]
+ * [Markmail](http://incubator.markmail.org/search/?q=list%3Aorg.apache.incubator.deltaspike-dev)
+ * [Nabble](https://s.apache.org/deltaspike-dev_nabble)
 
-# (Integration) Tests
+## (Integration) Tests
 So far we test the following environments on a regular basis (daily ci build)
 
  * Apache OpenWebBeans (embedded)
@@ -36,15 +36,15 @@ So far we test the following environment
  * JBoss Weld (embedded)
    ** Apache build server
  * JBoss AS7
-   ** [c4j|http://www.c4j.be]
+   ** [c4j](http://www.c4j.be)
  * Glassfish 3.1.x
-   ** [c4j|http://www.c4j.be]
+   ** [c4j](http://www.c4j.be)
  * Apache TomEE
    ** Apache build server
 
 So far we test the following environments on a regular basis (manually)
  * Weblogic Server 12c
-   ** [c4j|http://www.c4j.be]
+   ** [c4j](http://www.c4j.be)
 
 As soon as we have the corresponding config (and/or Arquillian Plugin)
  * Apache Tomcat 7

Modified: incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext?rev=1384295&r1=1384294&r2=1384295&view=diff
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext (original)
+++ incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext Thu Sep 13 12:17:53 2012
@@ -1,4 +1,4 @@
-Title: Tool Configuration
+Title: Tools
 Notice:    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
@@ -16,14 +16,4 @@ Notice:    Licensed to the Apache Softwa
            specific language governing permissions and limitations
            under the License.
 
-This page contains settings for various tools used at developing Apache DeltaSpike.
-
-# IDE
-
-## IntelliJ
-
-[Attached|^settings.jar] you can find the settings for formatting the source code. Import them via File | Import Settings...
-
-## Eclipse
-
-For Eclipse you can use this [Code Formatter Profile|^deltaspike-code-conventions.xml]. Import it via Window | Preferences | Java | Code Style | Formatter
+This page contains settings for various tools proposed by Apache DeltaSpike.
\ No newline at end of file

Modified: incubator/deltaspike/site/trunk/lib/path.pm
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/lib/path.pm?rev=1384295&r1=1384294&r2=1384295&view=diff
==============================================================================
--- incubator/deltaspike/site/trunk/lib/path.pm (original)
+++ incubator/deltaspike/site/trunk/lib/path.pm Thu Sep 13 12:17:53 2012
@@ -3,7 +3,9 @@ package path;
 # taken from django's url.py
 
 our @patterns = (
-	[qr!\.mdtext$!, single_narrative => { template => "standard_markdown.html" }],	
+	# [qr!\.mdtext$!, single_narrative => { template => "standard_markdown.html" }],
+
+	[qr!\.md(text)?$!, basic => { template => "standard_markdown.html" }],
 
 	[qr!/sitemap\.html$!, sitemap => { headers => { title => "Sitemap" }} ],
 

Modified: incubator/deltaspike/site/trunk/lib/view.pm
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/lib/view.pm?rev=1384295&r1=1384294&r2=1384295&view=diff
==============================================================================
--- incubator/deltaspike/site/trunk/lib/view.pm (original)
+++ incubator/deltaspike/site/trunk/lib/view.pm Thu Sep 13 12:17:53 2012
@@ -66,6 +66,54 @@ sub news_page {
     return Template($template)->render(\%args), html => \%args;
 }
 
+# A "basic" view, which takes 'template' and 'path' parameters.
+
+sub basic {
+    my %args = @_;
+    my $filepath = "content$args{path}";
+
+    print "basic $filepath";
+
+    read_text_file($filepath, \%args);
+
+    $args{path} =~ s/\.mdtext$/\.html/;
+    $args{base} = _base($args{path});
+    $args{breadcrumbs} = _breadcrumbs($args{path}, $args{base});
+
+    my $template_path = "templates/$args{template}";
+    my @includes = ($args{content} =~ m/{include:([^ ]+?)}/g);
+
+    foreach my $include (@includes) {
+
+        next unless ( -e "content/$include");
+
+        my %a = ();
+
+        read_text_file("content/$include", \%a);
+        my $text = $a{content};
+        $args{headers}{title} = $a{headers}{title} unless $args{headers}{title};
+
+        # If the file to be included is in a child directory, resolve all the links
+        # in the included content to be relative to this document
+        if ($include =~ m,/,) {
+            my $ipath = $include;
+            $ipath =~ s,/[^/]*$,,;
+            $text =~ s,(\[[^[]+])\(([^/][^)]+)\),$1($ipath/$2),g;
+        }
+
+        $args{content} =~ s/{include:$include}/$text/g;
+    }
+
+    print " - rendering";
+
+    my $rendered = Dotiac::DTL->new($template_path)->render(\%args);
+
+    print " - complete\n";
+
+    return ($rendered, 'html', \%args);
+}
+
+
 sub sitemap {
     my %args = @_;
     my $template = "content$args{path}";
@@ -119,6 +167,54 @@ sub breadcrumbs {
     return join " &raquo ", @rv;
 }
 
+sub _breadcrumbs {
+    my $path        = shift;
+    my $base        = shift;
+
+    my $index = "$base/index.html";
+    $index =~ s,/+,/,g;
+
+    my @breadcrumbs = (
+        qq|<a href="$index">Home</a>|,
+    );
+    my @path_components = split( m!/!, $path );
+    pop @path_components;
+
+    my $relpath = $base;
+
+
+    for (@path_components) {
+        $relpath .= "$_/";
+        $relpath =~ s,/+,/,g;
+        next unless $_;
+
+        my @names = split("-", $_);
+        my $name = "";
+        for my $n (@names) {
+            $name .= ucfirst($n) . " ";
+        }
+        $name =~ s/ *$//;
+        push @breadcrumbs, qq(<a href="$relpath">\u$name</a>);
+    }
+    return join "&nbsp;&raquo&nbsp;", @breadcrumbs;
+}
+
+sub _base {
+    my $path        = shift;
+
+    my @path_components = split( m!/!, $path );
+    pop @path_components;
+    pop @path_components;
+
+    my $rel = "./";
+
+    for (@path_components) {
+        $rel .= "../";
+    }
+
+    return $rel;
+}
+
 1;
 
 =head1 LICENSE