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/23 16:51:26 UTC

[activemq-website] branch jekyll-test-master updated: update the readme to better describe the automatic build+ staging setup

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

robbie pushed a commit to branch jekyll-test-master
in repository https://gitbox.apache.org/repos/asf/activemq-website.git


The following commit(s) were added to refs/heads/jekyll-test-master by this push:
     new a70b6b7  update the readme to better describe the automatic build+ staging setup
a70b6b7 is described below

commit a70b6b72344283413f40c3ac8888e493eb1e2406
Author: Robbie Gemmell <ro...@apache.org>
AuthorDate: Thu Jul 23 17:51:22 2020 +0100

    update the readme to better describe the automatic build+ staging setup
---
 README.md | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 77977be..10b4ca0 100644
--- a/README.md
+++ b/README.md
@@ -3,28 +3,26 @@ Apache ActiveMQ Website
 
 This is the repository for the Apache ActiveMQ website, hosted at [activemq.apache.org](http://activemq.apache.org/).
 
-*Warning*
+*NOTE*
 -------
 
-Do not change **anything** under ./content directly.
-This website is using [Jekyll](https://jekyllrb.com/), and the ./src will generate the ./content output.
-Please read it through this README before you contribute!
+This is a tryout of an automated build and staging setup for the website.
 
 How it works
 ------------
-The `master` branch of this repo contains the source files that are used to generate the HTML that ultimately gets pushed to the site, along with
-a copy of the generated site output located within the `content` directory, which is published to the live server using
-[gitpubsub](http://www.apache.org/dev/gitpubsub.html) whenever changes are pushed to it.
+The `jekyll-test-master` 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-staging` branch within the `output` directory. This directory is then published to the staging server at https://activemq.staged.apache.org/ where it can be verified before publishing the content to the  [...]
+
+When this tryout is finished, the process would be completed by e.g. rebasing the automated staging commit from `asf-staging` onto a live branch, for example `asf-site`, to publish it to the live site.
 
 See the *Contributing* section below for more.
 
 
-To Build the site
------------------
+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.
 
-To build the site from the `src` directory and store the output in the `content` directory, run the build script:
+To build the site from the `src` directory and store the output in the `_site` directory, run the build script:
 
     ./build.sh
 
@@ -61,6 +59,7 @@ If you would like to make a change to the ActiveMQ site:
 If you are a committer, do the following:
 
 1. Update the `master` branch with your (or a Pull Request's) changes.
-2. Run `build.sh` and ensure that all updates made are reflected in the `content` directory, commit any that are not.
-3. Push this branch to the ASF remote and the site will automatically be updated within seconds.
+2. Run `serve.sh`/ `build.sh`and very the updates made look appropriate.
+3. Push this branch to the ASF remote. The CI build will run and commit the generated output to the `asf-staging` branch automatically within a few minutes, from where it will be staged.
+4. Verify the staging site https://activemq.staged.apache.org/ works, then rebase the live branch with the contents of `asf-staging`.