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.

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

main update to docs local build v2 #661

Merged
merged 1 commit into from
Dec 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 20 additions & 29 deletions docs/README_local_build.adoc
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 0 additions & 2 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,3 @@ asciidoc:
requires: "'util=camel-website-util,kamelets=xref:js/kamelets.js'"
# Update to appropriate released camel-k version on release
camel-k-version: next
jsonpath-trace: true
jsonpath-debug: true
15 changes: 1 addition & 14 deletions docs/local-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
./antora-local-build.sh $LOCAL $*
17 changes: 17 additions & 0 deletions docs/source-map.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
28 changes: 17 additions & 11 deletions docs/source-watch.yml
Original file line number Diff line number Diff line change
@@ -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'