update to docs local build v2

apache · Dec 30, 2021 · a9a04f9 · a9a04f9
1 parent daa03c9
commit a9a04f9
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 21,863 deletions.
diff --git a/docs/.pnp.js b/docs/.pnp.js
diff --git a/docs/.yarnrc.yml b/docs/.yarnrc.yml
diff --git a/docs/README.adoc b/docs/README.adoc
diff --git a/docs/README_local_build.adoc 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/antora.yml b/docs/antora.yml
@@ -31,6 +31,3 @@ asciidoc:
     # attributes used in xrefs to other Antora components
     cq-camel-components: 3.14.x@components # replace ${camel.docs.components.xref}
     quarkus-examples-version: latest
-    # indexTable common
-    indexer-version: 3.14.x # replace ${camel.docs.components.version}
-    indexer-component: camel-quarkus
diff --git a/docs/bs-config.json b/docs/bs-config.json
diff --git a/docs/local-build.sh b/docs/local-build.sh
@@ -21,17 +21,4 @@ CW=./../../camel-website
 LOCAL=./../camel-quarkus
 
 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
+./antora-local-build.sh $LOCAL $*
diff --git a/docs/package.json b/docs/package.json
diff --git a/docs/source-watch.yml b/docs/source-watch.yml
@@ -20,14 +20,3 @@
       sources:
         - url: ./../camel-quarkus
         - url: https://github.com/apache/camel-quarkus-examples.git
-
-    - 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'
diff --git a/docs/util/jsonpath-util.js b/docs/util/jsonpath-util.js