You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ro...@apache.org on 2020/07/30 13:11:46 UTC
[activemq-website] branch master updated: tweak the readme a bit
This is an automated email from the ASF dual-hosted git repository.
robbie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/activemq-website.git
The following commit(s) were added to refs/heads/master by this push:
new a2313a9 tweak the readme a bit
a2313a9 is described below
commit a2313a9ccb777482bfac5f4d5ab228e4269778d1
Author: Robbie Gemmell <ro...@apache.org>
AuthorDate: Thu Jul 30 14:11:48 2020 +0100
tweak the readme a bit
---
README.md | 24 +++++++-----------------
1 file changed, 7 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 794b4c7..3165fba 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ This is the repository for the Apache ActiveMQ website, hosted at [activemq.apac
How it works
------------
-This branch of this repo contains the source files that are used to generate the HTML that ultimately gets pushed to the site. When a commit is made to the branch, a Jekyll build is automatically performed in CI and the generated site output committed back to the `asf-site` branch within the `output` directory. The generated content on `asf-site` is then automatically published to the live web server at https://activemq.apache.org/.
+This branch of the repo contains the source files that are used to generate the HTML that ultimately gets pushed to the site. When a commit is made to the branch, a Jekyll build is automatically performed in CI and the generated site output committed back to the `asf-site` branch within the `output` directory. The generated content on `asf-site` is then automatically published to the live web server at https://activemq.apache.org/.
See the *Contributing* section below for more.
@@ -13,30 +13,20 @@ See the *Contributing* section below for more.
To Build the site locally
-------------------------
-Before building the site you will need to install [Jekyll](https://jekyllrb.com/). The Jekyll site has [installation instructions](https://jekyllrb.com/docs/installation/) to help get you started.
+Before building the site you will need to install [Jekyll](https://jekyllrb.com/) (and Bundler). The Jekyll site has [installation instructions](https://jekyllrb.com/docs/installation/) to help get you started.
-To build the site from the `src` directory and store the output in the `_site` directory, run the build script:
-
- ./build.sh
-
-Alternatively, you can build and serve the site locally using Jekyll to test changes you have made or are making:
+You can build (from the `src` directory, to the `_site` output directory) and serve the site locally using Jekyll to test changes you have made or are making:
./serve.sh
-Note that these helper scripts perform incremental builds. If for some reason you need to clear the metadata/cache used to support the build process, you can run:
-
- rm -rf src/.jekyll-metadata .sass-cache/
+Alternatively, to just build the site, run:
+ ./build.sh
-Jekyll version
---------------
+Note that these helper scripts perform incremental builds. If for some reason you need to clear the metadata/cache used to support the build process, you can run:
-Before you build anything, make sure you are using the latest version of jekyll:
+ rm -rf src/.jekyll-metadata src/.jekyll-cache/
-```
-gem update jekyll
-gem update
-```
Contributing to the site
------------------------