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/29 16:35:00 UTC
[activemq-website] 01/02: disable publishing site,
shift base for build to the root dir and fix config to accomodate
automated build
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
commit 1cd82204d82598aabc798319c8df3f12964689b2
Author: Robbie Gemmell <ro...@apache.org>
AuthorDate: Wed Jul 22 14:47:09 2020 +0100
disable publishing site, shift base for build to the root dir and fix config to accomodate automated build
update the readme to better describe the automatic build + publish setup
---
.asf.yaml | 2 --
src/Gemfile => Gemfile | 0
README.md | 27 ++++++++++-----------------
src/_config.yml => _config.yml | 2 +-
build.sh | 2 +-
serve.sh | 2 +-
6 files changed, 13 insertions(+), 22 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
deleted file mode 100644
index 9a2e4f0..0000000
--- a/.asf.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
-publish:
- whoami: master
diff --git a/src/Gemfile b/Gemfile
similarity index 100%
rename from src/Gemfile
rename to Gemfile
diff --git a/README.md b/README.md
index 77977be..794b4c7 100644
--- a/README.md
+++ b/README.md
@@ -3,28 +3,19 @@ Apache ActiveMQ Website
This is the repository for the Apache ActiveMQ website, hosted at [activemq.apache.org](http://activemq.apache.org/).
-*Warning*
--------
-
-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!
-
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.
+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/.
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
@@ -53,14 +44,16 @@ If you would like to make a change to the ActiveMQ site:
1. Fork the [Apache ActiveMQ site repository](https://github.com/apache/activemq-website) to your github account.
2. Create a new branch from `master`
-3. Add commit(s) to your branch
-4. Test your changes locally
+3. Test your changes locally
+4. Add commit(s) to your branch
5. Open a pull request on the github mirror
6. An ActiveMQ committer will review and merge your changes
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 the changes to the ASF remote.
+4. The CI build will run and commit the generated site to the `asf-site` branch automatically within a few minutes, from where it will also be published. CI build status mails go to the commits list.
+4. Verify the updated website works as expected by browsing it.
diff --git a/src/_config.yml b/_config.yml
similarity index 94%
rename from src/_config.yml
rename to _config.yml
index 0fa82d7..38c6bf5 100644
--- a/src/_config.yml
+++ b/_config.yml
@@ -22,7 +22,7 @@ markdown: kramdown
highlighter: rouge
#permalink: /news/:year/:month/:day/:title/
excerpt_separator: ""
-destination: site-content
+source: src
exclude: [BUILD.md, Gemfile*]
keep_files: [.git]
exclude: [vendor]
diff --git a/build.sh b/build.sh
index 0c395ce..3f43e81 100755
--- a/build.sh
+++ b/build.sh
@@ -1,4 +1,4 @@
set -e
-jekyll build --incremental -s ./src/ -d ./content
+jekyll build --incremental
set +e
diff --git a/serve.sh b/serve.sh
index 928abcf..74813a5 100755
--- a/serve.sh
+++ b/serve.sh
@@ -1,4 +1,4 @@
set -e
-jekyll serve --incremental -s ./src -d content/
+jekyll serve --incremental
set +e