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:55:01 UTC
[camel-spring-boot] branch camel-spring-boot-3.11.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-spring-boot-3.11.x
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
The following commit(s) were added to refs/heads/camel-spring-boot-3.11.x by this push:
new 6199b85 update to docs local build v2
6199b85 is described below
commit 6199b85d1a3755f7f29ba383aa78d53902b7baeb
Author: David Jencks <dj...@apache.org>
AuthorDate: Tue Dec 28 16:29:16 2021 -0800
update to docs local build v2
---
docs/README_local_build.adoc | 22 ++++++++++++++++++++++
docs/local-build.sh | 24 ++++++++++++++++++++++++
docs/source-map.yml | 25 +++++++++++++++++++++++++
docs/source-watch.yml | 25 +++++++++++++++++++++++++
4 files changed, 96 insertions(+)
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
new file mode 100755
index 0000000..6e9d947
--- /dev/null
+++ b/docs/local-build.sh
@@ -0,0 +1,24 @@
+#!/bin/sh
+
+#
+# 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.
+#
+
+CW=./../../camel-website
+LOCAL=./../camel-spring-boot
+
+cd $CW || (echo 'camel-website not in expected location $CW' && exit)
+./antora-local-build.sh $LOCAL $*
diff --git a/docs/source-map.yml b/docs/source-map.yml
new file mode 100644
index 0000000..ba258da
--- /dev/null
+++ b/docs/source-map.yml
@@ -0,0 +1,25 @@
+#
+# 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:
+ - url: 'https://github.com/apache/camel-spring-boot.git'
+ mapped_url: './../camel-spring-boot'
+ branches:
+ - branch: camel-spring-boot-3.11.x
+ mapped_branch: HEAD
diff --git a/docs/source-watch.yml b/docs/source-watch.yml
new file mode 100644
index 0000000..2716147
--- /dev/null
+++ b/docs/source-watch.yml
@@ -0,0 +1,25 @@
+#
+# 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-spring-boot
+
+ - url: https://github.com/apache/camel.git
+ branch_includes: camel-3.11.x
+ start_path_includes: core/camel-core-engine/src/main/docs,docs/components