[camel-website] branch master updated: Add a table shortcode, getting-started and download pages

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[camel-website] branch master updated: Add a table shortcode, getting-started and download pages

zregvart
This is an automated email from the ASF dual-hosted git repository.

zregvart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 89f3b60  Add a table shortcode, getting-started and download pages
89f3b60 is described below

commit 89f3b609a3d3e61319deeadf5e77d68a4db48c4e
Author: Francois Papon <[hidden email]>
AuthorDate: Tue Feb 12 07:29:51 2019 +0400

    Add a table shortcode, getting-started and download pages
---
 antora-ui-camel/src/css/responsive.css  |   2 +
 content/docs/building.md                | 118 ++++++++++++++++++++++++++++++++
 content/docs/getting-started.md         |  40 ++++++++++-
 content/docs/sources.md                 |  39 +++++++++++
 content/download/_index.md              |  70 ++++++++++++++++++-
 layouts/docs/single.html                |   6 +-
 layouts/download/download.html          |   6 +-
 layouts/shortcodes/bootstrap-table.html |   9 +++
 8 files changed, 282 insertions(+), 8 deletions(-)

diff --git a/antora-ui-camel/src/css/responsive.css b/antora-ui-camel/src/css/responsive.css
index c8bfb3b..78964cf 100644
--- a/antora-ui-camel/src/css/responsive.css
+++ b/antora-ui-camel/src/css/responsive.css
@@ -1470,6 +1470,7 @@ mark,
   width: 100%;
   margin-bottom: 1rem;
   background-color: transparent;
+  border-collapse: collapse;
 }
 
 .table th,
@@ -1482,6 +1483,7 @@ mark,
 .table thead th {
   vertical-align: bottom;
   border-bottom: 2px solid #dee2e6;
+  font-weight: bold;
 }
 
 .table tbody + tbody {
diff --git a/content/docs/building.md b/content/docs/building.md
new file mode 100644
index 0000000..18dc92a
--- /dev/null
+++ b/content/docs/building.md
@@ -0,0 +1,118 @@
+---
+title: "Building"
+---
+
+## Building Camel from Source
+
+Camel uses [Maven](http://maven.apache.org/) as its build and management tool. If you don't fancy using Maven you can use your IDE directly or [Download](/download) a distribution or JAR.
+
+## Prequisites
+
+### Required:
+
+*  Download and [install Maven](http://maven.apache.org/download.html)
+  *  (Maven 3.1.1 or newer is required to build Camel 2.14 onwards)
+  *  (Maven 3.2.5 or newer is required to build Camel 2.18 onwards)
+  *  (Maven 3.3.3 or newer is required to build Camel 2.20 onwards)
+*  Get the latest [Source](https://camel.apache.org/source.html)
+*  Java
+  *  (1.7 or 1.8 to build Camel 2.14 onwards)
+  *  (1.8 to build Camel 2.18 onwards)
+  *  (1.9 experimental support for building Camel 2.19 onwards)
+
+## Maven options
+
+To build camel maven has to be configured to use more memory:
+
+### Unix/Linux/Mac
+
+```
+export MAVEN_OPTS="-Xms3000m -Xmx3000m -XX:MaxPermSize=512m"
+```
+
+### Windows
+
+```
+set MAVEN_OPTS=-Xms3000m -Xmx3000m -XX:MaxPermSize=512m
+```
+
+To conserve memory with Java 8 you can set two additional Java options -XX:+UseG1GC to enable G1 garbage collector (default in Java 9) and -XX:+UseStringDeduplication to help decrease Maven memory usage (up to 1.5GB is required currently, but set it a higher):
+
+### Unix/Linux/Mac
+
+```
+export MAVEN_OPTS="-Xmx2G -XX:+UseG1GC -XX:+UseStringDeduplication"
+
+```
+
+### Windows
+
+```
+set MAVEN_OPTS=-Xmx2G -XX:+UseG1GC -XX:+UseStringDeduplication
+```
+
+You can try to experiment with parallel builds by adding -T1.5C to MAVEN_OPTS, but be wary as some of the plugins are not thread safe, and the console output will be intertwined. With parallel builds and when using the install goal you might experience race conditions with the local repository, using [Takari Concurrent Local Repository](https://github.com/takari/takari-local-repository) will help with that.
+
+### A normal build
+
+```
+mvn clean install
+```
+
+## A normal build without running tests
+
+```
+mvn clean install -Pfastinstall
+```
+
+## A normal build without running tests but checkstyle verification enabled
+
+```
+mvn clean install -Pfastinstall,sourcecheck
+```
+
+## Doing a Quick Build
+
+### Available as of Camel 2.6
+
+The following skips building the manual, the distro and does not execute the unit tests.
+
+```
+mvn install -Pfastinstall
+```
+
+## Updating the license headers
+
+Proper license headers are enforced using Apache RAT and Checkstyle Maven plugins. To make it less tedious and error prone you can update the license headers by using:
+
+```
+mvn -Plicense license:format
+```
+
+This can be invoked from any module, which makes it useful when working on components. You can find the various license headers that the Camel project uses in buildtools/src/main/resources/header-*.txt files. These are regenerated at build time from header.txt in the same directory.
+
+## Building source jars
+
+If you want to build jar files with the source code, that for instance Eclipse can important so you can debug the Camel code as well. Then you can run this command from the camel root folder:
+
+```
+mvn clean source:jar install -Pfastinstall
+```
+
+## Working with karaf features
+
+If you change anything in the features.xml from platform/karaf you can run a validation step to ensure the generated features.xml file is correct. You can do this running the following maven goal from the platform directory.
+
+```
+mvn clean install -Pvalidate
+```
+
+## Executing unit tests using Ekstazi
+
+Normally, when you execute the unit tests during your development cycle for a particular component, you are executing all the tests each time. This may become inefficient, when you are changing one class and the effect of this change is limited within the component having many unit tests. Ekstazi is a regression testing tool that can keep track of the test results and the changed classes so that unaffected tests can be skipped during the subsequent testing. For more details of Ekstazi, p [...]
+
+To use Ekstazi, you can run the tests with the maven profile ekstazi.
+
+```
+mvn test -Pekstazi
+```
diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md
index a80cc81..f296500 100644
--- a/content/docs/getting-started.md
+++ b/content/docs/getting-started.md
@@ -1 +1,39 @@
-getting started!
+---
+title: "Getting started"
+---
+
+First you need to [Download](/download) the Camel distribution or you could grab the [Sources](/docs/sources) and try [Building](/docs/building) it yourself.
+
+Then come back here and you might want to read the following documentation before continuing:
+
+*  Longer Getting Started Guide
+*  Find out about Enterprise Integration Patterns and how to implement them with Camel
+*  Review the Architecture guide to see how to build Routes using the Java DSL or Spring based Xml Configuration
+
+## Working with CamelContexts and RouteBuilders
+
+To get started with Camel:
+
+*  Create a CamelContext.
+*  Optionally, configure components or endpoints.
+*  Add whatever routing rules you wish using the DSL and RouteBuilder or using Xml Configuration.
+*  Start the context.
+
+When your application is closing you may wish to stop the context
+
+When you are ready, why not Walk through an Example?
+And then continue the walk Walk through another example
+And after the walks head over to the tutorials.
+
+## Working with Spring
+
+If you use Spring as a Dependency Injection container then please refer to the Camel Spring documentation.
+
+## Other Resources
+
+We strongly suggest that you brew a cup of coffee or tea and take the 30 minutes to read one or more of the following resources:
+
+*  Camel in Action, Chapter 1 (direct link) free chapter 1 of the Camel in Action book. Highly recommended to read to learn what Camel is and the basic Camel concepts. This is a free chapter you can download directly as a pdf (about 20 pages) and introduces you to Camel. We have been told by experience Camel end users they wished this chapter was available to them when they started learning Camel.
+*  Open Source Integration with Apache Camel and How Fuse IDE Can Help by Jonathan Anstey. Updated article of the Apache Camel: Integration Nirvana. Great article to learn what Camel is and has a good use case example.
+*  Several of the vendors on the Commercial Camel Offerings page also offer various tutorials, webinars, examples, etc.... that may be useful.
+*  Articles is a link collection with articles, blogs, podcasts, presentations and the likes about Camel done by people from the community.
diff --git a/content/docs/sources.md b/content/docs/sources.md
new file mode 100644
index 0000000..4feaec7
--- /dev/null
+++ b/content/docs/sources.md
@@ -0,0 +1,39 @@
+---
+title: "Sources"
+---
+
+## Web Browsing of git
+
+To browse via the web:
+
+```
+https://git-wip-us.apache.org/repos/asf?p=camel.git
+```
+
+## Web Browsing Using FishEye
+
+A hearty thanks to [Atlassian](http://atlassian.com/) for providing [FishEye](http://cenqua.com/fisheye/) hosting for Camel. Below is the URL to browse the Subversion repo via FishEye:
+
+```
+https://fisheye6.atlassian.com/browse/camel-git
+```
+
+## Checking out from git
+
+```
+git clone https://git-wip-us.apache.org/repos/asf/camel.git
+```
+
+Only project developers can commit to the git via this method. SSH must be installed on your client machine. Enter your site password when prompted.
+
+## Using github
+
+The source code is mirrored to github, so you can also checkout the source code from github, if you are familiar with using github. By using github you can submit pull requests to the project using the standard github way.
+
+```
+https://github.com/apache/camel/
+```
+
+## Building the code
+
+To then build the code see [Building](/docs/building).
diff --git a/content/download/_index.md b/content/download/_index.md
index fb998ef..77190aa 100644
--- a/content/download/_index.md
+++ b/content/download/_index.md
@@ -1,2 +1,70 @@
-Download!
+---
+title: "Download"
+---
 
+## Latest release
+
+Grab these releases while they are hot!
+
+*  The latest release for Camel 2.23.x is [Camel 2.23.1 Release](https://camel.apache.org/camel-2231-release.html).
+*  The latest release for Camel 2.22.x is [Camel 2.22.3 Release](https://camel.apache.org/camel-2223-release.html).
+*  The latest release for Camel 2.21.x is [Camel 2.21.5 Release](https://camel.apache.org/camel-2215-release.html).
+*  Camel versions 2.20.x and older are no longer actively developed.
+
+## Older Releases
+
+See [Download Archives](download/archives.html)
+
+## Getting the latest distributions
+
+### Binary Distribution
+
+{{< bootstrap-table "table table-hover text-left" >}}
+| Description | Download Link | PGP Signature file of download | MD5 Checksum file of download | SHA1 Checksum file of download |
+|-------------|---------------|--------------------------------|-------------------------------|--------------------------------|
+| Windows Distribution (2.23.x branch) | [apache-camel-2.23.1.zip](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.23.1/apache-camel-2.23.1.zip&action=download) | [apache-camel-2.23.1.zip.asc](https://www.apache.org/dist/camel/apache-camel/2.23.1/apache-camel-2.23.1.zip.asc) | [apache-camel-2.23.1.zip.md5](https://www.apache.org/dist/camel/apache-camel/2.23.1/apache-camel-2.23.1.zip.md5) | [apache-camel-2.23.1.zip.sha1](https://www.apache.org/dist/camel/apache-camel/2. [...]
+| Unix/Linux/Cygwin Distribution (2.23.x branch) | [apache-camel-2.23.1.tar.gz](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.23.1/apache-camel-2.23.1.tar.gz&action=download) | [apache-camel-2.23.1.tar.gz.asc](https://www.apache.org/dist/camel/apache-camel/2.23.1/apache-camel-2.23.1.tar.gz.asc) | [apache-camel-2.23.1.tar.gz.md5](https://www.apache.org/dist/camel/apache-camel/2.23.1/apache-camel-2.23.1.tar.gz.md5) | [apache-camel-2.23.1.zip.sha1](https://www.apache.or [...]
+| Windows Distribution (2.22.x branch) | [apache-camel-2.22.3.zip](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.22.3/apache-camel-2.22.3.zip&action=download) | [apache-camel-2.22.3.zip.asc](https://www.apache.org/dist/camel/apache-camel/2.22.3/apache-camel-2.22.3.zip.asc) | [apache-camel-2.22.3.zip.md5](https://www.apache.org/dist/camel/apache-camel/2.22.3/apache-camel-2.22.3.zip.md5) | [apache-camel-2.22.3.zip.sha1](https://www.apache.org/dist/camel/apache-camel/2. [...]
+| Unix/Linux/Cygwin Distribution (2.22.x branch) | [apache-camel-2.22.3.tar.gz](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.22.3/apache-camel-2.22.3.tar.gz&action=download) | [apache-camel-2.22.3.tar.gz.asc](https://www.apache.org/dist/camel/apache-camel/2.22.3/apache-camel-2.22.3.tar.gz.asc) | [apache-camel-2.22.3.tar.gz.md5](https://www.apache.org/dist/camel/apache-camel/2.22.3/apache-camel-2.22.3.tar.gz.md5) | [apache-camel-2.22.3.zip.sha1](https://www.apache.or [...]
+| Windows Distribution (2.21.x branch) | [apache-camel-2.21.5.zip](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.21.5/apache-camel-2.21.5.zip&action=download) | [apache-camel-2.21.5.zip.asc](https://www.apache.org/dist/camel/apache-camel/2.21.5/apache-camel-2.21.5.zip.asc) | [apache-camel-2.21.5.zip.md5](https://www.apache.org/dist/camel/apache-camel/2.21.5/apache-camel-2.21.5.zip.md5) | [apache-camel-2.21.5.zip.sha1](https://www.apache.org/dist/camel/apache-camel/2. [...]
+| Unix/Linux/Cygwin Distribution (2.21.x branch) | [apache-camel-2.21.5.tar.gz](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.21.5/apache-camel-2.21.5.tar.gz&action=download) | [apache-camel-2.21.5.tar.gz.asc](https://www.apache.org/dist/camel/apache-camel/2.21.5/apache-camel-2.21.5.tar.gz.asc) | [apache-camel-2.21.5.tar.gz.md5](https://www.apache.org/dist/camel/apache-camel/2.21.5/apache-camel-2.21.5.tar.gz.md5) | [apache-camel-2.21.5.zip.sha1](https://www.apache.or [...]
+{{< /bootstrap-table >}}
+
+### Source Distribution
+
+{{< bootstrap-table "table table-hover text-left" >}}
+| Description | Download Link | PGP Signature file of download | MD5 Checksum file of download | SHA1 Checksum file of download |
+|-------------|---------------|--------------------------------|-------------------------------|--------------------------------|
+| Source (zip - 2.23.x branch) | [apache-camel-2.23.1-src.zip](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.23.1/apache-camel-2.23.1-src.zip&action=download) | [apache-camel-2.23.1-src.zip.asc](https://www.apache.org/dist/camel/apache-camel/2.23.1/apache-camel-2.23.1-src.zip.asc) | [apache-camel-2.23.1-src.zip.md5](https://www.apache.org/dist/camel/apache-camel/2.23.1/apache-camel-2.23.1-src.zip.md5) | [apache-camel-2.23.1-src.zip.sha1](https://www.apache.org/dist/c [...]
+| Source (zip - 2.22.x branch) | [apache-camel-2.22.3-src.zip](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.22.3/apache-camel-2.22.3-src.zip&action=download) | [apache-camel-2.22.3-src.zip.asc](https://www.apache.org/dist/camel/apache-camel/2.22.3/apache-camel-2.22.3-src.zip.asc) | [apache-camel-2.22.3-src.zip.md5](https://www.apache.org/dist/camel/apache-camel/2.22.3/apache-camel-2.22.3-src.zip.md5) | [apache-camel-2.22.3-src.zip.sha1](https://www.apache.org/dist/c [...]
+| Source (zip - 2.21.x branch) | [apache-camel-2.21.5-src.zip](http://www.apache.org/dyn/closer.lua?filename=camel/apache-camel/2.21.5/apache-camel-2.21.5-src.zip&action=download) | [apache-camel-2.21.5-src.zip.asc](https://www.apache.org/dist/camel/apache-camel/2.21.5/apache-camel-2.21.5-src.zip.asc) | [apache-camel-2.21.5-src.zip.md5](https://www.apache.org/dist/camel/apache-camel/2.21.5/apache-camel-2.21.5-src.zip.md5) | [apache-camel-2.21.5-src.zip.sha1](https://www.apache.org/dist/c [...]
+{{< /bootstrap-table >}}
+
+### Keys
+
+The KEYS used to sign the release can be found [here](https://www.apache.org/dist/camel/apache-camel/KEYS).
+
+### Getting the Binaries using Maven
+
+To use this release in your maven project, the proper dependency configuration that you should use in your Maven POM is:
+
+```
+<dependency>
+  <groupId>org.apache.camel</groupId>
+  <artifactId>camel-core</artifactId>
+  <version>2.23.1</version>
+</dependency>
+```
+
+### Getting past releases
+
+See the [Download Archives](/download-archives) for all time releases.
+
+## Maven 2 Repositories
+
+{{< bootstrap-table "table table-hover text-left" >}}
+| Description | Download Link |
+|-------------|---------------|
+|Apache Camel Releases | https://repository.apache.org/content/repositories/releases/org/apache/camel/apache-camel/ |
+|Apache Camel Releases (old) | For Camel 1.6.0 or older releases: http://people.apache.org/repo/m2-ibiblio-rsync-repository/ |
+{{< /bootstrap-table >}}
diff --git a/layouts/docs/single.html b/layouts/docs/single.html
index ef3a636..485bf39 100644
--- a/layouts/docs/single.html
+++ b/layouts/docs/single.html
@@ -1,9 +1,9 @@
 {{ partial "header.html" . }}
 
 <div class="container pb-5">
-    <div class="row">
-        {{ .Content }}
-    </div>
+    <h1>{{ .Title }}</h1>
+
+    {{ .Content }}
 </div>
 
 {{ partial "footer.html" . }}
diff --git a/layouts/download/download.html b/layouts/download/download.html
index ef3a636..485bf39 100644
--- a/layouts/download/download.html
+++ b/layouts/download/download.html
@@ -1,9 +1,9 @@
 {{ partial "header.html" . }}
 
 <div class="container pb-5">
-    <div class="row">
-        {{ .Content }}
-    </div>
+    <h1>{{ .Title }}</h1>
+
+    {{ .Content }}
 </div>
 
 {{ partial "footer.html" . }}
diff --git a/layouts/shortcodes/bootstrap-table.html b/layouts/shortcodes/bootstrap-table.html
new file mode 100644
index 0000000..0f1bf06
--- /dev/null
+++ b/layouts/shortcodes/bootstrap-table.html
@@ -0,0 +1,9 @@
+{{ $htmlTable := .Inner | markdownify }}
+{{ $class := .Get 0 }}
+{{ $old := "<table>" }}
+{{ $new := printf "<table class=\"%s\">" $class }}
+{{ $htmlTable := replace $htmlTable $old $new }}
+{{ $old := "<thead>" }}
+{{ $new := printf "<thead class=\"thead-light\">"}}
+{{ $htmlTable := replace $htmlTable $old $new }}
+{{ $htmlTable | safeHTML }}