You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by zr...@apache.org on 2019/08/02 17:17:09 UTC
[camel-website] branch master updated: CAMEL-13805: Add Camel
Quarkus page
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 3ee5193 CAMEL-13805: Add Camel Quarkus page
3ee5193 is described below
commit 3ee51936d61fc442d046acdf6af93e7c86eea98a
Author: Peter Palaga <pp...@redhat.com>
AuthorDate: Fri Aug 2 17:20:24 2019 +0200
CAMEL-13805: Add Camel Quarkus page
---
README.md | 75 ++++++++++++++++++++-------------------
config.toml | 14 ++++++++
content/projects/camel-quarkus.md | 11 ++++++
site.yml | 3 ++
4 files changed, 66 insertions(+), 37 deletions(-)
diff --git a/README.md b/README.md
index e810b55..196fc2e 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
# Apache Camel Website ![Logo][1]
This is a site generator project for Apache Camel. It generates static HTML and
-resources that are to be published.
+resources that are to be published.
Tools used to generate the website:
- - [Git](https://git-scm.com/) a source code management tool used to fetch document sources from different
+ - [Git](https://git-scm.com/) a source code management tool used to fetch document sources from different
github repositories.
- [Node.js](https://nodejs.org/) a JavaScript runtime used to build the website. You will need to use Node.js version 10.
- - [yarn](https://yarnpkg.com/) a blazing fast dependency and package manager tool used to download
+ - [yarn](https://yarnpkg.com/) a blazing fast dependency and package manager tool used to download
and manage required libraries.
- (installed via yarn) [Gulp](http://gulpjs.com/) a task automation tool. Used to build the Camel
Antora UI theme.
@@ -16,16 +16,17 @@ Tools used to generate the website:
directory and together with any resources in `static` directory generates output in
the `public` directory.
- (installed via yarn) [Antora](https://antora.org/) a documentation site generator. It uses
- Asciidoc documents from different sources in the [Camel](https://github.com/apache/camel)
- and [Camel K](https://github.com/apache/camel-k) repositories where user manual and component
- reference documentation resides and renders them for inclusion in this website.
+ Asciidoc documents from different sources in the [Camel](https://github.com/apache/camel),
+ [Camel K](https://github.com/apache/camel-k) and [Camel Quarkus](https://github.com/apache/camel-quarkus)
+ repositories where user manual and component reference documentation resides and renders them for inclusion in this
+ website.
- (optional) [Maven](https://maven.apache.org/) a build tool used to run the complete website generating process
## Build with Node and yarn
-You can build the website locally using the tools `Node.js` and `yarn`.
+You can build the website locally using the tools `Node.js` and `yarn`.
-If you can not use these tools on your local machine for some reason you can also build the website using Maven as
+If you can not use these tools on your local machine for some reason you can also build the website using Maven as
described in section ["Build with Maven"](#build-with-maven).
### Preparing the tools
@@ -38,7 +39,7 @@ Make sure that you have Node.js (herein "`Node`") installed.
If this command fails with an error, you do not have Node installed.
-This project requires the Node LTS version 10 (e.g., v10.15.3).
+This project requires the Node LTS version 10 (e.g., v10.15.3).
Please make sure to have a suitable version of Node installed. You have several options to install
Node on your machine.
@@ -47,7 +48,7 @@ Node on your machine.
- Install using [Homebrew](https://brew.sh/) and [Node formulae](https://formulae.brew.sh/formula/node)
- Install from official [Node packages](https://nodejs.org/en/download/)
-Note - If you have different Node version other than Node LTS version 10 you can use following command to make
+Note - If you have different Node version other than Node LTS version 10 you can use following command to make
Node LTS version 10 as default Node version.
$ nvm alias default 10
@@ -64,12 +65,12 @@ Clone the Apache Camel Website project using git:
$ git clone https://github.com/apache/camel-website.git
-The command above clones the Apache Camel Website project. After that you can switch to the new
+The command above clones the Apache Camel Website project. After that you can switch to the new
project directory on your filesystem.
## Build the Antora Camel UI theme
-First step is to build the Antora ui theme used for the Apache Camel website. The theme sources are located
+First step is to build the Antora ui theme used for the Apache Camel website. The theme sources are located
inside [Project root directory/antora-ui-camel](antora-ui-camel). So first switch to that directory:
$ cd antora-ui-camel
@@ -79,14 +80,14 @@ In that directory execute:
$ yarn install # needed only once, or if dependencies change
$ yarn build # to perform the ui theme build
-You should see the Antora theme bundle generated in in [antora-ui-camel/build/ui-bundle.zip](antora-ui-camel).
+You should see the Antora theme bundle generated in in [antora-ui-camel/build/ui-bundle.zip](antora-ui-camel).
-The Camel Antora UI theme should not be a subject to change very frequently. So you might execute this once and
-never come back.
+The Camel Antora UI theme should not be a subject to change very frequently. So you might execute this once and
+never come back.
-## Build the website content
+## Build the website content
-Building the website requires the built Antora Camel UI theme bundle from above. Please check that
+Building the website requires the built Antora Camel UI theme bundle from above. Please check that
the theme bundle exists in [antora-ui-camel/build/ui-bundle.zip](antora-ui-camel).
To build the website go to the project root directory and run:
@@ -94,21 +95,21 @@ To build the website go to the project root directory and run:
$ yarn install # needed only once, or if dependencies change
$ yarn build # to perform the build
-This should fetch doc sources for [Camel](https://github.com/apache/camel) and [Camel K](https://github.com/apache/camel-k)
+This should fetch doc sources for [Camel](https://github.com/apache/camel) and [Camel K](https://github.com/apache/camel-k)
and generate the website with Hugo. You should see the generated website in the `public` directory.
## Preview website locally
-You can preview the Apache Camel website on your local machine once you have the generated website available in
+You can preview the Apache Camel website on your local machine once you have the generated website available in
the `public` directory.
-Hugo can start a simple web server serving the generated site content so you can view it in your favorite browser.
+Hugo can start a simple web server serving the generated site content so you can view it in your favorite browser.
Simply call
$ yarn preview
-and you will be provided with a web server running the site on [http://localhost:1313/](http://localhost:1313/)
+and you will be provided with a web server running the site on [http://localhost:1313/](http://localhost:1313/)
Point your favorite browser to `http://localhost:1313/` and you will see the Apache Camel website.
@@ -120,7 +121,7 @@ The Apache Camel website is composed of different sources. So where to add and c
#### Menu
-The site main menu is defined in the top level configuration [config.toml](config.toml). You can add/change
+The site main menu is defined in the top level configuration [config.toml](config.toml). You can add/change
menu items there.
#### Content
@@ -167,7 +168,7 @@ of the different page categories including footer and header templates.
### Changes in Antora UI theme
-The Antora UI theme basically defines the look and feel of the website. You can find the theme sources within this
+The Antora UI theme basically defines the look and feel of the website. You can find the theme sources within this
repository in [antora-ui-camel](antora-ui-camel).
You need to rebuild the Antora UI theme in order to see your changes reflected locally.
@@ -177,9 +178,9 @@ You need to rebuild the Antora UI theme in order to see your changes reflected l
The Apache Camel website includes documentation sources from other github repositories. Content sources are defined in
[site.yml](site.yml).
-At the moment these sources are documentation sources form [Camel](https://github.com/apache/camel)
-and [Camel K](https://github.com/apache/camel-k). These are basically the component reference docs and the Camel user
-manual. In case you want to change something here please go to the respective github repository and contribute your
+At the moment these sources are documentation sources form [Camel](https://github.com/apache/camel)
+and [Camel K](https://github.com/apache/camel-k). These are basically the component reference docs and the Camel user
+manual. In case you want to change something here please go to the respective github repository and contribute your
change there.
- [Camel components](https://github.com/apache/camel/tree/master/docs/components)
@@ -196,10 +197,10 @@ Your changes in these repositories will automatically get visible on the website
The project provides a simple way to build the website sources locally using the build tool [Maven](https://maven.apache.org/).
-The Maven build automatically downloads the tool binaries such as `node` and `yarn` for you. You do not need to install
+The Maven build automatically downloads the tool binaries such as `node` and `yarn` for you. You do not need to install
those tools on your host then. The binaries are added to the local project sources only and generate the website content.
-As the Maven build uses pinned versions of `node` and `yarn` that are tested to build the website you most likely avoid
+As the Maven build uses pinned versions of `node` and `yarn` that are tested to build the website you most likely avoid
build errors due to incompatible versions of `Node.js` tooling installed on your machine.
### Preparing Maven
@@ -210,17 +211,17 @@ Make sure that you have Maven installed.
If this command fails with an error, you do not have Maven installed.
-Please install Maven using your favorite package manager (like [Homebrew](https://brew.sh/)) or from
+Please install Maven using your favorite package manager (like [Homebrew](https://brew.sh/)) or from
official [Maven binaries](https://maven.apache.org/install.html)
-
-### Building from scratch
-
+
+### Building from scratch
+
When building everything from scratch the build executes following steps:
- Download `yarn` and `Node.js` binaries to the local project
- Load required libraries to the local project using `yarn`
- Build the Antora Camel UI theme ([antora-ui-camel](antora-ui-camel))
-- Fetch the doc sources from [Camel](https://github.com/apache/camel)
+- Fetch the doc sources from [Camel](https://github.com/apache/camel)
and [Camel K](https://github.com/apache/camel-k) github reporsitories
- Build the website content using Hugo
@@ -243,12 +244,12 @@ This should save you some minutes in the build process. You can find the updated
### Clean build
-When rebuilding the website the process uses some cached content (e.g. the fetched doc sources for
-[Camel](https://github.com/apache/camel) and [Camel K](https://github.com/apache/camel-k) or the Antora ui theme).
-If you want to start from scratch for some reason you can simply add the `clean` operation to the build which removes
+When rebuilding the website the process uses some cached content (e.g. the fetched doc sources for
+[Camel](https://github.com/apache/camel) and [Camel K](https://github.com/apache/camel-k) or the Antora ui theme).
+If you want to start from scratch for some reason you can simply add the `clean` operation to the build which removes
all generated sources in the project first.
$ mvn clean package
-
+
Of course this then takes some more time than an optimized rebuild (time to grab another coffee!).
diff --git a/config.toml b/config.toml
index 3aac0f4..e18e655 100644
--- a/config.toml
+++ b/config.toml
@@ -26,6 +26,13 @@ enableRobotsTXT = true
url = "/projects/camel-k/"
[[menu.main]]
+ name = "Camel Quarkus"
+ parent = "projects"
+ weight = 2
+ identifier = "project-camel-quarkus"
+ url = "/projects/camel-quarkus/"
+
+[[menu.main]]
name = "Documentation"
identifier = "docs"
weight = 4
@@ -59,6 +66,13 @@ enableRobotsTXT = true
url = "/camel-k/latest/"
[[menu.main]]
+ name = "Camel Quarkus"
+ parent = "docs"
+ weight = 5
+ identifier = "camel-quarkus"
+ url = "/camel-quarkus/latest/"
+
+[[menu.main]]
name = "Community"
identifier = "community"
weight = 5
diff --git a/content/projects/camel-quarkus.md b/content/projects/camel-quarkus.md
new file mode 100644
index 0000000..2d84f92
--- /dev/null
+++ b/content/projects/camel-quarkus.md
@@ -0,0 +1,11 @@
+---
+title: Camel Quarkus
+---
+
+# Apache Camel extensions for Quarkus
+
+This project hosts the efforts to port and package the 280+ Camel components as Quarkus extensions.
+
+[Quarkus](https://quarkus.io/) is a Java platform offering fast boot times and low memory footprint. It targets both stock JVMs (OpenJDK in the first place) and GraalVM.
+
+For more information, please refer to the [Camel Quarkus Documentation](../../camel-quarkus/latest/) or check the [Camel Quarkus code](https://github.com/apache/camel-quarkus/) on GitHub.
diff --git a/site.yml b/site.yml
index 4c431c4..b8aeab8 100644
--- a/site.yml
+++ b/site.yml
@@ -14,6 +14,9 @@ content:
- url: git@github.com:apache/camel-k.git
branches: master
start_path: docs
+ - url: git@github.com:apache/camel-quarkus.git
+ branches: master
+ start_path: docs
ui:
bundle: