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:47:18 UTC
[camel-kamelets] branch 0.6.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 0.6.x
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
The following commit(s) were added to refs/heads/0.6.x by this push:
new 23c7ff2 update to docs local build v2
23c7ff2 is described below
commit 23c7ff292dfa6976d73ecd5126d7626093098e31
Author: David Jencks <dj...@apache.org>
AuthorDate: Mon Dec 27 20:48:03 2021 -0800
update to docs local build v2
---
docs/README_local_build.adoc | 49 ++++++++++++++++++--------------------------
docs/local-build.sh | 15 +-------------
docs/source-map.yml | 17 +++++++++++++++
docs/source-watch.yml | 28 +++++++++++++++----------
4 files changed, 55 insertions(+), 54 deletions(-)
diff --git a/docs/README_local_build.adoc b/docs/README_local_build.adoc
index 75bdd8e..1d2b8da 100644
--- a/docs/README_local_build.adoc
+++ b/docs/README_local_build.adoc
@@ -1,31 +1,22 @@
= Local/partial build of docs
-This should be explained soon at https://camel.apache.org/manual/improving-the-documentation.html.
-
-* (once, or occasionally)
-. In `../..` (next to this project's clone) run
-[source,sh]
-----
-git clone https://github.com/apache/camel-website.git
-----
-. In `../../camel-website/antora-ui-camel` run
-[source,sh]
-----
-yarn build
-----
-. In this directory run
-[source,sh]
-----
-./local-build.sh full
-----
-This will build the full Antora site on your machine in the camel-website project under /documentation, with any local changes you have made in this project.
-It will also do a full xref check for the entire site.
-* Thereafter
-. In this directory run
-[source,sh]
-----
-./local-build.sh
-----
-
-This will build just this project, with local changes, into the full build from the previous step.
-It will start a local webserver for the build site, rebuild when changes are detected, and sync your browser to the changes.
+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 cf1a8fa..db1ee78 100755
--- a/docs/local-build.sh
+++ b/docs/local-build.sh
@@ -21,17 +21,4 @@ CW=./../../camel-website
LOCAL=./../camel-kamelets
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-map.yml b/docs/source-map.yml
index e2d433a..717ad39 100644
--- a/docs/source-map.yml
+++ b/docs/source-map.yml
@@ -1,3 +1,20 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
- require: '@djencks/antora-source-map'
# log_level: trace
source-map:
diff --git a/docs/source-watch.yml b/docs/source-watch.yml
index 857b71f..8c9a75d 100644
--- a/docs/source-watch.yml
+++ b/docs/source-watch.yml
@@ -1,15 +1,21 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
- require: '@djencks/antora-source-watch'
# log_level: trace
sources:
- url: ./../camel-kamelets
-
- - 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