You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by dj...@apache.org on 2021/12/30 23:51:46 UTC
[camel] branch camel-3.13.x updated: update to docs local build v2
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a commit to branch camel-3.13.x
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/camel-3.13.x by this push:
new f7f5fb9 update to docs local build v2
f7f5fb9 is described below
commit f7f5fb9db23144a1aa0684b5f9b3700d886baceb
Author: David Jencks <dj...@apache.org>
AuthorDate: Tue Dec 28 14:10:44 2021 -0800
update to docs local build v2
---
docs/README_local_build.adoc | 22 ++++++++++++++++++++++
docs/local-build.sh | 15 +--------------
docs/source-watch.yml | 14 +-------------
3 files changed, 24 insertions(+), 27 deletions(-)
diff --git a/docs/README_local_build.adoc b/docs/README_local_build.adoc
new file mode 100644
index 0000000..1d2b8da
--- /dev/null
+++ b/docs/README_local_build.adoc
@@ -0,0 +1,22 @@
+= Local/partial build of docs
+
+See https://camel.apache.org/manual/improving-the-documentation.html for initial setup instructions and more details.
+
+After initial setup, there are three local build options:
+
+== Quick: `./local-build.sh quick`
+
+This will build this project only.
+Links out of this component will go to the published Camel website, and there will be no links back.
+This is primarily intended to check for errors.
+
+== Full: `./local-build.sh full`
+
+This will build the full site locally, with your changes in this project.
+Running this (at least) once is a prerequisite for the partial build.
+This should show the site exactly as it would be should your changes be merged.
+
+== Partial: `./local-build.sh`
+
+This will build this project only, replacing this component in the locally built "full" build, and start a local server to view with, rebuild the project when file changes are detected, and sync your browser with the rebuilt site.
+This is intended for documentation development.
diff --git a/docs/local-build.sh b/docs/local-build.sh
index c8dd05d..cd375d8b 100755
--- a/docs/local-build.sh
+++ b/docs/local-build.sh
@@ -21,17 +21,4 @@ CW=./../../camel-website
LOCAL=./../camel
cd $CW || (echo 'camel-website not in expected location $CW' && exit)
-cp antora-playbook.yml local-antora-playbook-full.yml
-cat $LOCAL/docs/source-map.yml >> local-antora-playbook-full.yml
-cat playbook-patch-full.yml >> local-antora-playbook-full.yml
-
-cp antora-playbook.yml local-antora-playbook-partial.yml
-cat $LOCAL/docs/source-map.yml >> local-antora-playbook-partial.yml
-cat $LOCAL/docs/source-watch.yml >> local-antora-playbook-partial.yml
-
-if [ "$1" = "full" ] || [ "$1" = "1" ]
-then
- yarn build:antora-local-full
-else
- yarn build:antora-local-partial
-fi
\ No newline at end of file
+./antora-local-build.sh $LOCAL $*
diff --git a/docs/source-watch.yml b/docs/source-watch.yml
index 497ee30..d8ff615 100644
--- a/docs/source-watch.yml
+++ b/docs/source-watch.yml
@@ -16,22 +16,10 @@
#
- require: '@djencks/antora-source-watch'
-# log_level: debug
+# log_level: trace
sources:
- url: ./../camel
- url: https://github.com/apache/camel-spring-boot.git
branch_includes: camel-spring-boot-3.13.x
start_path_includes: docs/components,components-starter
- components:
-
- - require: "@djencks/antora-site-manifest"
- import_manifests:
- - primary_site_manifest_url: ./documentation/site-manifest.json
- partial_components: true
- local-urls: true
-
- - require: '@djencks/antora-timer'
- log_level: info
-
- generator: '@djencks/antora-source-watch'
\ No newline at end of file