Skip to content
Permalink
Browse files
update to docs local build v2
  • Loading branch information
djencks committed Dec 30, 2021
1 parent 00ea36d commit 6c089d59e6ff0c628f886b182414b4706d199849
Showing 3 changed files with 23 additions and 25 deletions.
@@ -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.
@@ -21,17 +21,4 @@ CW=./../../camel-website
LOCAL=./../camel-kafka-connector

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 $*
@@ -21,14 +21,3 @@
- url: ./../camel-kafka-connector
component: camel-kafka-connector
version: next

- 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'

0 comments on commit 6c089d5

Please sign in to comment.