You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by cd...@apache.org on 2017/12/22 09:02:46 UTC
[incubator-plc4x] branch master updated: PLC4X-11 - Setup the site
generation
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
The following commit(s) were added to refs/heads/master by this push:
new 6841742 PLC4X-11 - Setup the site generation
6841742 is described below
commit 68417427c7a2f629f54c04dc058bf9b110c8772b
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Fri Dec 22 10:02:34 2017 +0100
PLC4X-11 - Setup the site generation
- Removed the "draft" watermark from the generated content and CSS styles
- Updated the SCM Urls in the root-pom
- Added some configuration to deploy the site to a "asf-site" branch in the same repo
---
pom.xml | 37 +++++++++++++++++++++++++++----
src/site/asciidoc/infra/website.adoc | 43 ++++++++++++++++++++++++++++++++++++
src/site/resources/css/site.css | 27 ----------------------
src/site/site.xml | 5 +----
4 files changed, 77 insertions(+), 35 deletions(-)
diff --git a/pom.xml b/pom.xml
index 6ad7ead..f9f86c2 100644
--- a/pom.xml
+++ b/pom.xml
@@ -42,8 +42,8 @@
<inceptionYear>2017</inceptionYear>
<scm>
- <connection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-plc4x.git</connection>
- <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-plc4x.git</developerConnection>
+ <connection>scm:git:https://gitbox.apache.org/repos/asf/incubator-plc4x.git</connection>
+ <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/incubator-plc4x.git</developerConnection>
<url>https://github.com/apache/incubator-plc4x</url>
<tag>HEAD</tag>
</scm>
@@ -52,7 +52,7 @@
<distributionManagement>
<site>
<id>apache.website</id>
- <url>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-plc4x.git</url>
+ <url>scm:git:https://gitbox.apache.org/repos/asf/incubator-plc4x.git</url>
</site>
</distributionManagement>
@@ -329,7 +329,10 @@
</execution>
</executions>
</plugin>
- <!-- Replace the bootstrap css with the version of the theme -->
+
+ <!--
+ Replace the bootstrap css with the version of the theme
+ -->
<plugin>
<groupId>com.googlecode.maven-download-plugin</groupId>
<artifactId>download-maven-plugin</artifactId>
@@ -361,6 +364,7 @@
</execution>
</executions>
</plugin>
+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
@@ -447,6 +451,31 @@
</dependency>
</dependencies>
</plugin>
+
+ <!--
+ Make the maven-site-plugin stage the output in the "asf-site" branch
+ -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-publish-plugin</artifactId>
+ <version>1.1</version>
+ <executions>
+ <execution>
+ <id>scm-publish</id>
+ <phase>site-deploy</phase>
+ <!-- deploy site with maven-scm-publish-plugin -->
+ <goals>
+ <goal>publish-scm</goal>
+ </goals>
+ <configuration>
+ <!-- mono-module doesn't require site:stage -->
+ <content>${project.build.directory}/site</content>
+ <!-- branch where to deploy -->
+ <scmBranch>asf-site</scmBranch>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
<pluginManagement>
diff --git a/src/site/asciidoc/infra/website.adoc b/src/site/asciidoc/infra/website.adoc
new file mode 100644
index 0000000..a8143bc
--- /dev/null
+++ b/src/site/asciidoc/infra/website.adoc
@@ -0,0 +1,43 @@
+//
+// 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.
+//
+
+== Generating the Website
+
+The PLC4X project uses Apache `gitpubsub` system for maintaining the website.
+
+In general all content in the repos `asf-site` branch is copied to the Webservers.
+
+This content is generated during the `Maven` build as part of the `site` generation.
+
+As the build system needs to check-in content to our GIT repo to the `asf-site` branch.
+Jenkins doesn't have the credentials to push to repositories on all nodes. Only a small subset of the nodes are configured to do this.
+
+In oder to be able to push the site changes, nodes with the label `git-websites` have to be used.
+
+
+
+
+
+
+
+In order to have the `gitbox` system automatically deploy the content, we finally need to add an entry to this config file:
+https://svn.apache.org/repos/infra/infrastructure/buildbot/aegis/buildmaster/master1/projects/cms.conf
+
+As our build now requires to run on `buildbot`, we need to ensure all required software is installed on the build machine.
+
+If something is missing, this has to be added to the following resource:
+https://github.com/apache/infrastructure-puppet/blob/deployment/data/nodes/bb-slave1.apache.org.yaml
\ No newline at end of file
diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css
index d440f94..79f8a11 100644
--- a/src/site/resources/css/site.css
+++ b/src/site/resources/css/site.css
@@ -47,30 +47,3 @@ under the License.
.protocolParameter {
background-color: #80DED9;
}
-
-#watermark {
- position: fixed;
- top: 150px;
- right: -150px;
- width: 500px;
- height:140px;
- padding-left: 150px;
- z-index: 1;
- display: block;
- background-color: red;
- color: red;
- transform: rotate(45deg);
- -webkit-transform: rotate(45deg);
-}
-
-#watermark-text {
- color: white;
- font-size: 50px;
- width: 380px;
- text-align: center;
-}
-
-#bottomNote {
- color: red;
- font-size: 20px;
-}
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
index 22db3e0..fbee2da 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -49,10 +49,7 @@
</brand>
<bottomDescription>
<![CDATA[
- <p id="bottomNote">Bottom Note: This site is currently a draft, we are currently in the process of preparing the project for incubation at Apache but are not yet finished with that yet. Hopefully within the next few weeks we will be an official Apache Incubator project.</p>
- <div id="watermark">
- <p id="watermark-text">This is a draft. See bottom note.</p>
- </div>
+ <p id="bottomNote"></p>
]]>
</bottomDescription>
<breadcrumbs>true</breadcrumbs>
--
To stop receiving notification emails like this one, please contact
['"commits@plc4x.apache.org" <co...@plc4x.apache.org>'].