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 2022/08/19 14:11:08 UTC
[activemq-website] branch main updated: Add ability to 'serve' only a subset of the site, the most likely to change. Much more responsive than doing it all.
This is an automated email from the ASF dual-hosted git repository.
robbie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-website.git
The following commit(s) were added to refs/heads/main by this push:
new 6287be182 Add ability to 'serve' only a subset of the site, the most likely to change. Much more responsive than doing it all.
6287be182 is described below
commit 6287be1824d078908336d2578e504ed3219f613c
Author: Robbie Gemmell <ro...@apache.org>
AuthorDate: Fri Aug 19 14:54:21 2022 +0100
Add ability to 'serve' only a subset of the site, the most likely to change. Much more responsive than doing it all.
---
README.md | 5 +++
_config_subset_excludes.yml | 82 +++++++++++++++++++++++++++++++++++++++++++++
clean.sh | 2 ++
serve_subset.sh | 12 +++++++
4 files changed, 101 insertions(+)
diff --git a/README.md b/README.md
index c9470d60b..d325797c1 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,11 @@ If for some reason you need to clear the metadata/cache used to support the buil
rm -rf src/.jekyll-*
rm -rf _site
+There is a `./clean.sh` helper script provided that does the above.
+
+Note there is also a `./serve_subset.sh` helper script. This uses additional configuration from `_config_subset_excludes.yml` to omit building
+older release content that doesnt typically change, significantly improving responsiveness while working on additions not affecting those areas.
+It works best when starting without existing full _site output, which can be cleaned out as noted above.
Contributing to the site
------------------------
diff --git a/_config_subset_excludes.yml b/_config_subset_excludes.yml
new file mode 100644
index 000000000..d29374d65
--- /dev/null
+++ b/_config_subset_excludes.yml
@@ -0,0 +1,82 @@
+# Additional site settings, with more excludes to omit various older content, only
+# leaving the smaller subset more typically updated, giving a much faster [re]build.
+
+# These need to be exact paths, not wildcards.
+exclude: [
+vendor,
+maven/5.15.9,
+maven/5.17.0,
+components/cms/api_docs,
+components/nms/msdoc,
+components/artemis/documentation/1.0.0,
+components/artemis/documentation/1.1.0,
+components/artemis/documentation/1.2.0,
+components/artemis/documentation/1.3.0,
+components/artemis/documentation/1.4.0,
+components/artemis/documentation/1.5.0,
+components/artemis/documentation/1.5.1,
+components/artemis/documentation/1.5.2,
+components/artemis/documentation/1.5.3,
+components/artemis/documentation/1.5.4,
+components/artemis/documentation/1.5.5,
+components/artemis/documentation/1.5.6,
+components/artemis/documentation/2.0.0,
+components/artemis/documentation/2.1.0,
+components/artemis/documentation/2.2.0,
+components/artemis/documentation/2.3.0,
+components/artemis/documentation/2.4.0,
+components/artemis/documentation/2.5.0,
+components/artemis/documentation/2.6.0,
+components/artemis/documentation/2.7.0,
+components/artemis/documentation/2.8.0,
+components/artemis/documentation/2.9.0,
+components/artemis/documentation/2.10.0,
+components/artemis/documentation/2.10.1,
+components/artemis/documentation/2.11.0,
+components/artemis/documentation/2.12.0,
+components/artemis/documentation/2.13.0,
+components/artemis/documentation/2.14.0,
+components/artemis/documentation/2.15.0,
+components/artemis/documentation/2.16.0,
+components/artemis/documentation/2.17.0,
+components/artemis/documentation/2.18.0,
+components/artemis/documentation/2.19.0,
+components/artemis/documentation/2.20.0,
+components/artemis/documentation/2.21.0,
+components/artemis/documentation/2.22.0,
+components/artemis/documentation/2.23.1,
+components/artemis/documentation/javadocs/javadoc-1.0.0,
+components/artemis/documentation/javadocs/javadoc-1.1.0,
+components/artemis/documentation/javadocs/javadoc-1.2.0,
+components/artemis/documentation/javadocs/javadoc-1.3.0,
+components/artemis/documentation/javadocs/javadoc-1.4.0,
+components/artemis/documentation/javadocs/javadoc-1.5.0,
+components/artemis/documentation/javadocs/javadoc-1.5.1,
+components/artemis/documentation/javadocs/javadoc-1.5.2,
+components/artemis/documentation/javadocs/javadoc-1.5.3,
+components/artemis/documentation/javadocs/javadoc-1.5.6,
+components/artemis/documentation/javadocs/javadoc-2.0.0,
+components/artemis/documentation/javadocs/javadoc-2.1.0,
+components/artemis/documentation/javadocs/javadoc-2.2.0,
+components/artemis/documentation/javadocs/javadoc-2.3.0,
+components/artemis/documentation/javadocs/javadoc-2.4.0,
+components/artemis/documentation/javadocs/javadoc-2.5.0,
+components/artemis/documentation/javadocs/javadoc-2.6.0,
+components/artemis/documentation/javadocs/javadoc-2.7.0,
+components/artemis/documentation/javadocs/javadoc-2.8.0,
+components/artemis/documentation/javadocs/javadoc-2.9.0,
+components/artemis/documentation/javadocs/javadoc-2.10.0,
+components/artemis/documentation/javadocs/javadoc-2.10.1,
+components/artemis/documentation/javadocs/javadoc-2.11.0,
+components/artemis/documentation/javadocs/javadoc-2.12.0,
+components/artemis/documentation/javadocs/javadoc-2.13.0,
+components/artemis/documentation/javadocs/javadoc-2.14.0,
+components/artemis/documentation/javadocs/javadoc-2.15.0,
+components/artemis/documentation/javadocs/javadoc-2.16.0,
+components/artemis/documentation/javadocs/javadoc-2.17.0,
+components/artemis/documentation/javadocs/javadoc-2.18.0,
+components/artemis/documentation/javadocs/javadoc-2.19.0,
+components/artemis/documentation/javadocs/javadoc-2.20.0,
+components/artemis/documentation/javadocs/javadoc-2.22.0,
+components/artemis/documentation/javadocs/javadoc-2.23.1
+]
diff --git a/clean.sh b/clean.sh
new file mode 100755
index 000000000..6c33f70d6
--- /dev/null
+++ b/clean.sh
@@ -0,0 +1,2 @@
+rm -rf ./src/.jekyll-*
+rm -rf ./_site
diff --git a/serve_subset.sh b/serve_subset.sh
new file mode 100755
index 000000000..45113a278
--- /dev/null
+++ b/serve_subset.sh
@@ -0,0 +1,12 @@
+set -e
+bundle install
+# Not using --incremental as it doesnt interact well with the
+# metadata based generation used in release process updates
+# and isnt dramatically faster regardless.
+echo "=========================== WARNING ==============================="
+echo "Various content excluded for perf, see _config_subset_excludes.yml."
+echo "Run the full serve/build process to test changes in those areas."
+echo "==================================================================="
+bundle exec jekyll serve --config _config.yml,_config_subset_excludes.yml --livereload
+set +e
+