Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update to docs local build v2 #1305

Merged
merged 1 commit into from
Dec 30, 2021
Merged

update to docs local build v2 #1305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/README_local_build.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 1 addition & 14 deletions docs/local-build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 $*
11 changes: 0 additions & 11 deletions docs/source-watch.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'