[camel-website] branch master updated: chore: update README

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

[camel-website] branch master updated: chore: update README

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 5017036  chore: update README
5017036 is described below

commit 501703681bd8219dbc15547c41e14934f4a3b21e
Author: Zoran Regvart <[hidden email]>
AuthorDate: Tue Mar 10 11:00:19 2020 +0100

    chore: update README
   
    Adds more details on rebuilding and working with CSS/JavaScript.
---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 9e0f296..204981d 100644
--- a/README.md
+++ b/README.md
@@ -121,6 +121,14 @@ and you will be provided with a web server running the site on [http://localhost
 
 Point your favorite browser to `http://localhost:1313/` and you will see the Apache Camel website.
 
+Changes that are made to the content managed by Hugo (i.e. content, layouts, config.toml) are applied automatically and reloaded in the browser. To make changes to the content managed by Antora, a rebuild needs to be done. The same is true for the CSS changes in the `antora-ui-camel`. To rebuild you can run, in another terminal window, from the root directory of the website:
+
+    $ (cd antora-ui-camel && yarn build) && yarn antora --require ./menu.js site.yml
+
+This will build the `antora-ui-camel` which holds all the CSS and JavaScript, and then rebuild the documentation, resulting in an updated content in the `documentation` directory.
+
+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.
+
 ## Contribute changes
 
 The Apache Camel website is composed of different sources. So where to add and contribute changes in particular?