[camel-website] branch master updated: chore: add documentation on `CAMEL_EVN` variable

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

[camel-website] branch master updated: chore: add documentation on `CAMEL_EVN` variable

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 de0abb0  chore: add documentation on `CAMEL_EVN` variable
de0abb0 is described below

commit de0abb028a736223834dbbb67d743415d800c5b5
Author: Zoran Regvart <[hidden email]>
AuthorDate: Sun Jun 7 16:08:05 2020 +0200

    chore: add documentation on `CAMEL_EVN` variable
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 09a563c..f856159 100644
--- a/README.md
+++ b/README.md
@@ -171,6 +171,16 @@ This will build the `antora-ui-camel` which holds all the CSS and JavaScript, an
 
 To iterate quickly, it's easier to make changes directly in the browser tooling and then bring the changes over to the CSS files after the fact.
 
+## CAMEL_ENV environment variable
+
+Setting the `CAMEL_ENV` changes the output of the website build slightly, possible values are `development` (set by default if `CAMEL_ENV` is unset), `production` or `netlify`.
+
+To run the optimizations, which currently consist of running [htmlmin](https://kangax.github.io/html-minifier/) to reduce the size of generated HTML documents, set the `CAMEL_ENV` environment variable to `production`, for example:
+
+    $ CAMEL_ENV=production yarn build
+
+When build is performed on Netlify, we set it to `netlify` to add the link to Netlify required by Netlify's open source policy.
+
 ## Contribute changes
 
 The Apache Camel website is composed of different sources. So where to add and contribute changes in particular?