docs changes, mostly generated

apache · Apr 30, 2020 · c4593a6 · oscerd · May 1, 2020 · oscerd
1 parent d21735f
commit c4593a6
Show file tree

Hide file tree

Showing 35 changed files with 139 additions and 343 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,2 @@
 node_modules/*
-public/*
+build
diff --git a/docs/README.adoc b/docs/README.adoc
@@ -11,22 +11,26 @@ yarn install
 
 == Local development
 
-To build the local copy of the website and preview it, execute:
+To build the partial website from the local worktree, execute:
 
 ```
-yarn dev
+yarn build
 ```
 
-== Build the Documentation Website
+== Build and preview
 
-To generate the documentation website from the remote repository branch, execute:
+To build the partial website from the local worktree and preview the results, execute:
 
 ```
-yarn build
+yarn preview
 ```
 
-To preview it in the local browser, execute:
+== xref check
+
+To check the xrefs in the partial site, execute:
 
 ```
-yarn preview
+yarn checks
 ```
+
+Valid xrefs to parts of the site in other sources will appear as (spurious) errors.
diff --git a/docs/antora-playbook-dev.yml b/docs/antora-playbook-dev.yml
diff --git a/docs/antora-playbook.yml b/docs/antora-playbook.yml
@@ -5,11 +5,12 @@ site:
 content:
   sources:
   - url: ../
-    branches: master
+    branches: HEAD
     start_path: docs
+asciidoc:
+  extensions:
+    - "@djencks/asciidoctor-antora-indexer"
 ui:
   bundle:
     url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
     snapshot: true
-output:
-  dir: ./public
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -14,32 +14,30 @@
 ** xref:configuration/logging.adoc[Logging]
 ** xref:configuration/dependencies.adoc[Dependencies]
 ** xref:configuration/configmap-secret.adoc[ConfigMap/Secret]
-* xref:traits/traits.adoc[Traits]
+* xref:traits:traits.adoc[Traits]
 // Start of autogenerated code - DO NOT EDIT! (trait-nav)
-** xref:traits/3scale.adoc[3scale]
-** xref:traits/affinity.adoc[Affinity]
-** xref:traits/builder.adoc[Builder]
-** xref:traits/camel.adoc[Camel]
-** xref:traits/container.adoc[Container]
-** xref:traits/cron.adoc[Cron]
-** xref:traits/dependencies.adoc[Dependencies]
-** xref:traits/deployer.adoc[Deployer]
-** xref:traits/deployment.adoc[Deployment]
-** xref:traits/environment.adoc[Environment]
-** xref:traits/gc.adoc[Gc]
-** xref:traits/ingress.adoc[Ingress]
-** xref:traits/istio.adoc[Istio]
-** xref:traits/jolokia.adoc[Jolokia]
-** xref:traits/jvm.adoc[Jvm]
-** xref:traits/knative-service.adoc[Knative Service]
-** xref:traits/knative.adoc[Knative]
-** xref:traits/master.adoc[Master]
-** xref:traits/openapi.adoc[Openapi]
-** xref:traits/owner.adoc[Owner]
-** xref:traits/platform.adoc[Platform]
-** xref:traits/prometheus.adoc[Prometheus]
-** xref:traits/pull-secret.adoc[Pull Secret]
-** xref:traits/quarkus.adoc[Quarkus]
-** xref:traits/route.adoc[Route]
-** xref:traits/service.adoc[Service]
+** xref:traits:affinity.adoc[Affinity]
+** xref:traits:builder.adoc[Builder]
+** xref:traits:camel.adoc[Camel]
+** xref:traits:container.adoc[Container]
+** xref:traits:cron.adoc[Cron]
+** xref:traits:dependencies.adoc[Dependencies]
+** xref:traits:deployer.adoc[Deployer]
+** xref:traits:deployment.adoc[Deployment]
+** xref:traits:environment.adoc[Environment]
+** xref:traits:gc.adoc[Gc]
+** xref:traits:ingress.adoc[Ingress]
+** xref:traits:istio.adoc[Istio]
+** xref:traits:jolokia.adoc[Jolokia]
+** xref:traits:jvm.adoc[Jvm]
+** xref:traits:knative-service.adoc[Knative Service]
+** xref:traits:knative.adoc[Knative]
+** xref:traits:openapi.adoc[Openapi]
+** xref:traits:owner.adoc[Owner]
+** xref:traits:platform.adoc[Platform]
+** xref:traits:prometheus.adoc[Prometheus]
+** xref:traits:pull-secret.adoc[Pull Secret]
+** xref:traits:quarkus.adoc[Quarkus]
+** xref:traits:route.adoc[Route]
+** xref:traits:service.adoc[Service]
 // End of autogenerated code - DO NOT EDIT! (trait-nav)
diff --git a/docs/modules/ROOT/pages/traits/3scale.adoc b/docs/modules/ROOT/pages/traits/3scale.adoc
diff --git a/docs/modules/ROOT/pages/traits/debug.adoc b/docs/modules/ROOT/pages/traits/debug.adoc
diff --git a/docs/modules/ROOT/pages/traits/master.adoc b/docs/modules/ROOT/pages/traits/master.adoc
diff --git a/docs/modules/ROOT/pages/traits/affinity.adoc → docs/modules/traits/pages/affinity.adoc b/docs/modules/ROOT/pages/traits/affinity.adoc → docs/modules/traits/pages/affinity.adoc
@@ -52,23 +52,3 @@ integration pod(s) should not be co-located with.
 |===
 
 // End of autogenerated code - DO NOT EDIT! (configuration)
-
-== Examples
-
-* To schedule the integration pod(s) on a specific node using the https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#interlude-built-in-node-labels[built-in node label] `kubernetes.io/hostname`:
-[source,shell]
-$ kamel run -t affinity.node-affinity-labels="kubernetes.io/hostname in(node-66-50.hosted.k8s.tld)" ...
-
-* To schedule a single integration pod per node (using the `Exists` operator):
-[source,shell]
-$ kamel run -t affinity.pod-anti-affinity-labels="camel.apache.org/integration" ...
-
-* To co-locate the integration pod(s) with other integration pod(s):
-[source,shell]
-$ kamel run -t affinity.pod-affinity-labels="camel.apache.org/integration in(it1, it2)" ...
-
-The labels options follow the requirements from https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors[Label selectors]. They can be multi-valuated, then the requirements list is ANDed, e.g., to schedule a single integration pod per node AND not co-located with the Camel K operator pod(s):
-[source,shell]
-$ kamel run -t affinity.pod-anti-affinity-labels="camel.apache.org/integration" -t affinity.pod-anti-affinity-labels="camel.apache.org/component=operator" ...
-
-More information can be found in the official Kubernetes documentation about https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[Assigning Pods to Nodes].
diff --git a/docs/modules/ROOT/pages/traits/builder.adoc → docs/modules/traits/pages/builder.adoc b/docs/modules/ROOT/pages/traits/builder.adoc → docs/modules/traits/pages/builder.adoc
diff --git a/docs/modules/ROOT/pages/traits/camel.adoc → docs/modules/traits/pages/camel.adoc b/docs/modules/ROOT/pages/traits/camel.adoc → docs/modules/traits/pages/camel.adoc
diff --git a/.../modules/ROOT/pages/traits/container.adoc → docs/modules/traits/pages/container.adoc b/.../modules/ROOT/pages/traits/container.adoc → docs/modules/traits/pages/container.adoc
diff --git a/docs/modules/ROOT/pages/traits/cron.adoc → docs/modules/traits/pages/cron.adoc b/docs/modules/ROOT/pages/traits/cron.adoc → docs/modules/traits/pages/cron.adoc
@@ -19,20 +19,6 @@ The rules for using a Kubernetes CronJob are the following:
 This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**.
 
 // End of autogenerated code - DO NOT EDIT! (description)
-
-== Examples
-
-The following route is materialized into a Kubernetes CronJob by the `cron` trait:
-
-.cron.groovy
-[source,groovy]
-----
-from('timer:groovy?period=60000') // Setting the period e.g. to '1000' restores the default behavior
-  .setBody()
-    .simple('Hello World from Camel K in a CronJob')
-  .to('log:info?showAll=false')
-----
-
 // Start of autogenerated code - DO NOT EDIT! (configuration)
 == Configuration
 

diff --git a/...dules/ROOT/pages/traits/dependencies.adoc → docs/modules/traits/pages/dependencies.adoc b/...dules/ROOT/pages/traits/dependencies.adoc → docs/modules/traits/pages/dependencies.adoc
diff --git a/docs/modules/ROOT/pages/traits/deployer.adoc → docs/modules/traits/pages/deployer.adoc b/docs/modules/ROOT/pages/traits/deployer.adoc → docs/modules/traits/pages/deployer.adoc
diff --git a/...modules/ROOT/pages/traits/deployment.adoc → docs/modules/traits/pages/deployment.adoc b/...modules/ROOT/pages/traits/deployment.adoc → docs/modules/traits/pages/deployment.adoc
diff --git a/...odules/ROOT/pages/traits/environment.adoc → docs/modules/traits/pages/environment.adoc b/...odules/ROOT/pages/traits/environment.adoc → docs/modules/traits/pages/environment.adoc
diff --git a/docs/modules/ROOT/pages/traits/gc.adoc → docs/modules/traits/pages/gc.adoc b/docs/modules/ROOT/pages/traits/gc.adoc → docs/modules/traits/pages/gc.adoc
@@ -25,7 +25,7 @@ The following configuration options are available:
 | Can be used to enable or disable a trait. All traits share this common property.
 
 | gc.discovery-cache
-| github.com/apache/camel-k/pkg/trait.discoveryCacheType
+| ./pkg/trait.discoveryCacheType
 | Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`)
 
 |===

diff --git a/docs/modules/ROOT/pages/traits/ingress.adoc → docs/modules/traits/pages/ingress.adoc b/docs/modules/ROOT/pages/traits/ingress.adoc → docs/modules/traits/pages/ingress.adoc
diff --git a/docs/modules/ROOT/pages/traits/istio.adoc → docs/modules/traits/pages/istio.adoc b/docs/modules/ROOT/pages/traits/istio.adoc → docs/modules/traits/pages/istio.adoc
diff --git a/docs/modules/ROOT/pages/traits/jolokia.adoc → docs/modules/traits/pages/jolokia.adoc b/docs/modules/ROOT/pages/traits/jolokia.adoc → docs/modules/traits/pages/jolokia.adoc
diff --git a/docs/modules/ROOT/pages/traits/jvm.adoc → docs/modules/traits/pages/jvm.adoc b/docs/modules/ROOT/pages/traits/jvm.adoc → docs/modules/traits/pages/jvm.adoc
diff --git a/...es/ROOT/pages/traits/knative-service.adoc → ...modules/traits/pages/knative-service.adoc b/...es/ROOT/pages/traits/knative-service.adoc → ...modules/traits/pages/knative-service.adoc
diff --git a/docs/modules/ROOT/pages/traits/knative.adoc → docs/modules/traits/pages/knative.adoc b/docs/modules/ROOT/pages/traits/knative.adoc → docs/modules/traits/pages/knative.adoc
diff --git a/docs/modules/ROOT/pages/traits/openapi.adoc → docs/modules/traits/pages/openapi.adoc b/docs/modules/ROOT/pages/traits/openapi.adoc → docs/modules/traits/pages/openapi.adoc
@@ -1,4 +1,4 @@
-= OpenAPI
+= Openapi Trait
 
 // Start of autogenerated code - DO NOT EDIT! (description)
 The OpenAPI DSL trait is internally used to allow creating integrations from a OpenAPI specs.

diff --git a/docs/modules/ROOT/pages/traits/owner.adoc → docs/modules/traits/pages/owner.adoc b/docs/modules/ROOT/pages/traits/owner.adoc → docs/modules/traits/pages/owner.adoc
diff --git a/docs/modules/ROOT/pages/traits/platform.adoc → docs/modules/traits/pages/platform.adoc b/docs/modules/ROOT/pages/traits/platform.adoc → docs/modules/traits/pages/platform.adoc
diff --git a/...modules/ROOT/pages/traits/prometheus.adoc → docs/modules/traits/pages/prometheus.adoc b/...modules/ROOT/pages/traits/prometheus.adoc → docs/modules/traits/pages/prometheus.adoc
diff --git a/...odules/ROOT/pages/traits/pull-secret.adoc → docs/modules/traits/pages/pull-secret.adoc b/...odules/ROOT/pages/traits/pull-secret.adoc → docs/modules/traits/pages/pull-secret.adoc
diff --git a/docs/modules/ROOT/pages/traits/quarkus.adoc → docs/modules/traits/pages/quarkus.adoc b/docs/modules/ROOT/pages/traits/quarkus.adoc → docs/modules/traits/pages/quarkus.adoc
diff --git a/docs/modules/ROOT/pages/traits/route.adoc → docs/modules/traits/pages/route.adoc b/docs/modules/ROOT/pages/traits/route.adoc → docs/modules/traits/pages/route.adoc
diff --git a/docs/modules/ROOT/pages/traits/service.adoc → docs/modules/traits/pages/service.adoc b/docs/modules/ROOT/pages/traits/service.adoc → docs/modules/traits/pages/service.adoc
diff --git a/docs/modules/ROOT/pages/traits/traits.adoc → docs/modules/traits/pages/traits.adoc b/docs/modules/ROOT/pages/traits/traits.adoc → docs/modules/traits/pages/traits.adoc
@@ -33,31 +33,6 @@ A trait may have additional properties that can be configured by the end user.
 
 See the trait description pages for more information on a specific trait:
 
-// Start of autogenerated code - DO NOT EDIT! (trait-list)
-* xref:traits/3scale.adoc[3scale Trait]
-* xref:traits/affinity.adoc[Affinity Trait]
-* xref:traits/builder.adoc[Builder Trait]
-* xref:traits/camel.adoc[Camel Trait]
-* xref:traits/container.adoc[Container Trait]
-* xref:traits/cron.adoc[Cron Trait]
-* xref:traits/dependencies.adoc[Dependencies Trait]
-* xref:traits/deployer.adoc[Deployer Trait]
-* xref:traits/deployment.adoc[Deployment Trait]
-* xref:traits/environment.adoc[Environment Trait]
-* xref:traits/gc.adoc[Gc Trait]
-* xref:traits/ingress.adoc[Ingress Trait]
-* xref:traits/istio.adoc[Istio Trait]
-* xref:traits/jolokia.adoc[Jolokia Trait]
-* xref:traits/jvm.adoc[Jvm Trait]
-* xref:traits/knative-service.adoc[Knative Service Trait]
-* xref:traits/knative.adoc[Knative Trait]
-* xref:traits/master.adoc[Master Trait]
-* xref:traits/openapi.adoc[Openapi Trait]
-* xref:traits/owner.adoc[Owner Trait]
-* xref:traits/platform.adoc[Platform Trait]
-* xref:traits/prometheus.adoc[Prometheus Trait]
-* xref:traits/pull-secret.adoc[Pull Secret Trait]
-* xref:traits/quarkus.adoc[Quarkus Trait]
-* xref:traits/route.adoc[Route Trait]
-* xref:traits/service.adoc[Service Trait]
-// End of autogenerated code - DO NOT EDIT! (trait-list)
+There are indexCount:[] traits.
+
+indexList::[]
diff --git a/docs/package.json b/docs/package.json
@@ -4,15 +4,15 @@
   "description": "Camel K Documentation",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@antora/cli": "~2.3.0",
-    "@antora/site-generator-default": "~2.3.0",
+    "@antora/cli": "~2.3.1",
+    "@antora/site-generator-default": "~2.3.1",
     "@antora/xref-validator": "gitlab:antora/xref-validator",
+    "@djencks/asciidoctor-antora-indexer": "^0.0.2",
     "lite-server": "^2.4.0"
   },
   "scripts": {
-    "preview": "cd public && lite-server",
+    "preview": "yarn build && cd build/site && lite-server",
     "build": "yarn antora --stacktrace antora-playbook.yml",
-    "dev": "yarn antora --stacktrace antora-playbook-dev.yml && yarn preview",
     "checks": "yarn antora --generator @antora/xref-validator antora-playbook.yml"
   }
 }