This is an automated email from the ASF dual-hosted git repository. djencks pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit c4593a6f0d96ade2f36a4c0cf9183dfebe3ccca6 Author: David Jencks <[email protected]> AuthorDate: Thu Apr 30 09:51:56 2020 -0700 docs changes, mostly generated --- docs/.gitignore | 2 +- docs/README.adoc | 18 ++- docs/antora-playbook-dev.yml | 15 -- docs/antora-playbook.yml | 7 +- docs/modules/ROOT/nav.adoc | 52 +++---- docs/modules/ROOT/pages/traits/3scale.adoc | 52 ------- docs/modules/ROOT/pages/traits/debug.adoc | 30 ---- docs/modules/ROOT/pages/traits/master.adoc | 57 ------- .../pages/traits => traits/pages}/affinity.adoc | 20 --- .../pages/traits => traits/pages}/builder.adoc | 0 .../{ROOT/pages/traits => traits/pages}/camel.adoc | 0 .../pages/traits => traits/pages}/container.adoc | 0 .../{ROOT/pages/traits => traits/pages}/cron.adoc | 14 -- .../traits => traits/pages}/dependencies.adoc | 0 .../pages/traits => traits/pages}/deployer.adoc | 0 .../pages/traits => traits/pages}/deployment.adoc | 0 .../pages/traits => traits/pages}/environment.adoc | 0 .../{ROOT/pages/traits => traits/pages}/gc.adoc | 2 +- .../pages/traits => traits/pages}/ingress.adoc | 0 .../{ROOT/pages/traits => traits/pages}/istio.adoc | 0 .../pages/traits => traits/pages}/jolokia.adoc | 0 .../{ROOT/pages/traits => traits/pages}/jvm.adoc | 0 .../traits => traits/pages}/knative-service.adoc | 0 .../pages/traits => traits/pages}/knative.adoc | 0 .../pages/traits => traits/pages}/openapi.adoc | 2 +- .../{ROOT/pages/traits => traits/pages}/owner.adoc | 0 .../pages/traits => traits/pages}/platform.adoc | 0 .../pages/traits => traits/pages}/prometheus.adoc | 0 .../pages/traits => traits/pages}/pull-secret.adoc | 0 .../pages/traits => traits/pages}/quarkus.adoc | 0 .../{ROOT/pages/traits => traits/pages}/route.adoc | 0 .../pages/traits => traits/pages}/service.adoc | 0 .../pages/traits => traits/pages}/traits.adoc | 31 +--- docs/package.json | 8 +- docs/yarn.lock | 172 +++++++++++---------- 35 files changed, 139 insertions(+), 343 deletions(-) diff --git a/docs/.gitignore b/docs/.gitignore index 48d99bd..2f361ab 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,2 @@ node_modules/* -public/* \ No newline at end of file +build \ No newline at end of file diff --git a/docs/README.adoc b/docs/README.adoc index 19accc0..c5be674 100644 --- 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 deleted file mode 100644 index 96004a6..0000000 --- a/docs/antora-playbook-dev.yml +++ /dev/null @@ -1,15 +0,0 @@ -site: - title: Camel K - url: https://camel.apache.org/ - start_page: camel-k::index.adoc -content: - sources: - - url: ../ - branches: HEAD - start_path: docs -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/antora-playbook.yml b/docs/antora-playbook.yml index 540f827..6917dcf 100644 --- 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 index a2f625f..f752f1d 100644 --- 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 deleted file mode 100755 index ff11f2c..0000000 --- a/docs/modules/ROOT/pages/traits/3scale.adoc +++ /dev/null @@ -1,52 +0,0 @@ -= 3scale Trait - -// Start of autogenerated code - DO NOT EDIT! (description) -The 3scale trait can be used to automatically create annotations that allow -3scale to discover the generated service and make it available for API management. - -The 3scale trait is disabled by default. - - -This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**. - -// End of autogenerated code - DO NOT EDIT! (description) -// Start of autogenerated code - DO NOT EDIT! (configuration) -== Configuration - -Trait properties can be specified when running any integration with the CLI: -``` -kamel run --trait 3scale.[key]=[value] --trait 3scale.[key2]=[value2] integration.groovy -``` -The following configuration options are available: - -[cols="2,1,5a"] -|=== -|Property | Type | Description - -| 3scale.enabled -| bool -| Can be used to enable or disable a trait. All traits share this common property. - -| 3scale.auto -| bool -| Enables automatic configuration of the trait. - -| 3scale.scheme -| string -| The scheme to use to contact the service (default `http`) - -| 3scale.path -| string -| The path where the API is published (default `/`) - -| 3scale.port -| int -| The port where the service is exposed (default `80`) - -| 3scale.description-path -| string -| The path where the Open-API specification is published (default `/api-doc`) - -|=== - -// End of autogenerated code - DO NOT EDIT! (configuration) diff --git a/docs/modules/ROOT/pages/traits/debug.adoc b/docs/modules/ROOT/pages/traits/debug.adoc deleted file mode 100755 index 8cb42af..0000000 --- a/docs/modules/ROOT/pages/traits/debug.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= Debug Trait - -// Start of autogenerated code - DO NOT EDIT! (description) -The Debug trait can be used to enable debugging on the integration container, -so that a remote debugger can be attached. - - -This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**. - -// End of autogenerated code - DO NOT EDIT! (description) -// Start of autogenerated code - DO NOT EDIT! (configuration) -== Configuration - -Trait properties can be specified when running any integration with the CLI: -``` -kamel run --trait debug.[key]=[value] integration.groovy -``` -The following configuration options are available: - -[cols="2,1,5a"] -|=== -|Property | Type | Description - -| debug.enabled -| bool -| Can be used to enable or disable a trait. All traits share this common property. - -|=== - -// End of autogenerated code - DO NOT EDIT! (configuration) diff --git a/docs/modules/ROOT/pages/traits/master.adoc b/docs/modules/ROOT/pages/traits/master.adoc deleted file mode 100755 index ff8eb9d..0000000 --- a/docs/modules/ROOT/pages/traits/master.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= Master Trait - -// Start of autogenerated code - DO NOT EDIT! (description) -The Master trait allows to configure the integration to automatically leverage Kubernetes resources for doing -leader election and starting *master* routes only on certain instances. - -It's activated automatically when using the master endpoint in a route, e.g. `from("master:lockname:telegram:bots")...`. - -NOTE: this trait adds special permissions to the integration service account in order to read/write configmaps and read pods. -It's recommended to use a different service account than "default" when running the integration. - - -This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**. - -// End of autogenerated code - DO NOT EDIT! (description) -// Start of autogenerated code - DO NOT EDIT! (configuration) -== Configuration - -Trait properties can be specified when running any integration with the CLI: -``` -kamel run --trait master.[key]=[value] --trait master.[key2]=[value2] integration.groovy -``` -The following configuration options are available: - -[cols="2,1,5a"] -|=== -|Property | Type | Description - -| master.enabled -| bool -| Can be used to enable or disable a trait. All traits share this common property. - -| master.auto -| bool -| Enables automatic configuration of the trait. - -| master.include-delegate-dependencies -| bool -| When this flag is active, the operator analyzes the source code to add dependencies required by delegate endpoints. -E.g. when using `master:lockname:timer`, then `camel:timer` is automatically added to the set of dependencies. -It's enabled by default. - -| master.configmap -| string -| Name of the configmap that will be used to store the lock. Defaults to "<integration-name>-lock". - -| master.label-key -| string -| Label that will be used to identify all pods contending the lock. Defaults to "camel.apache.org/integration". - -| master.label-value -| string -| Label value that will be used to identify all pods contending the lock. Defaults to the integration name. - -|=== - -// End of autogenerated code - DO NOT EDIT! (configuration) diff --git a/docs/modules/ROOT/pages/traits/affinity.adoc b/docs/modules/traits/pages/affinity.adoc similarity index 57% rename from docs/modules/ROOT/pages/traits/affinity.adoc rename to docs/modules/traits/pages/affinity.adoc index f0d035d..3238390 100755 --- a/docs/modules/ROOT/pages/traits/affinity.adoc +++ b/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 b/docs/modules/traits/pages/builder.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/builder.adoc rename to docs/modules/traits/pages/builder.adoc diff --git a/docs/modules/ROOT/pages/traits/camel.adoc b/docs/modules/traits/pages/camel.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/camel.adoc rename to docs/modules/traits/pages/camel.adoc diff --git a/docs/modules/ROOT/pages/traits/container.adoc b/docs/modules/traits/pages/container.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/container.adoc rename to docs/modules/traits/pages/container.adoc diff --git a/docs/modules/ROOT/pages/traits/cron.adoc b/docs/modules/traits/pages/cron.adoc similarity index 90% rename from docs/modules/ROOT/pages/traits/cron.adoc rename to docs/modules/traits/pages/cron.adoc index 08ba412..6343754 100755 --- a/docs/modules/ROOT/pages/traits/cron.adoc +++ b/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/docs/modules/ROOT/pages/traits/dependencies.adoc b/docs/modules/traits/pages/dependencies.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/dependencies.adoc rename to docs/modules/traits/pages/dependencies.adoc diff --git a/docs/modules/ROOT/pages/traits/deployer.adoc b/docs/modules/traits/pages/deployer.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/deployer.adoc rename to docs/modules/traits/pages/deployer.adoc diff --git a/docs/modules/ROOT/pages/traits/deployment.adoc b/docs/modules/traits/pages/deployment.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/deployment.adoc rename to docs/modules/traits/pages/deployment.adoc diff --git a/docs/modules/ROOT/pages/traits/environment.adoc b/docs/modules/traits/pages/environment.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/environment.adoc rename to docs/modules/traits/pages/environment.adoc diff --git a/docs/modules/ROOT/pages/traits/gc.adoc b/docs/modules/traits/pages/gc.adoc similarity index 94% rename from docs/modules/ROOT/pages/traits/gc.adoc rename to docs/modules/traits/pages/gc.adoc index 3f2a864..0b61f3e 100755 --- a/docs/modules/ROOT/pages/traits/gc.adoc +++ b/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 b/docs/modules/traits/pages/ingress.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/ingress.adoc rename to docs/modules/traits/pages/ingress.adoc diff --git a/docs/modules/ROOT/pages/traits/istio.adoc b/docs/modules/traits/pages/istio.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/istio.adoc rename to docs/modules/traits/pages/istio.adoc diff --git a/docs/modules/ROOT/pages/traits/jolokia.adoc b/docs/modules/traits/pages/jolokia.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/jolokia.adoc rename to docs/modules/traits/pages/jolokia.adoc diff --git a/docs/modules/ROOT/pages/traits/jvm.adoc b/docs/modules/traits/pages/jvm.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/jvm.adoc rename to docs/modules/traits/pages/jvm.adoc diff --git a/docs/modules/ROOT/pages/traits/knative-service.adoc b/docs/modules/traits/pages/knative-service.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/knative-service.adoc rename to docs/modules/traits/pages/knative-service.adoc diff --git a/docs/modules/ROOT/pages/traits/knative.adoc b/docs/modules/traits/pages/knative.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/knative.adoc rename to docs/modules/traits/pages/knative.adoc diff --git a/docs/modules/ROOT/pages/traits/openapi.adoc b/docs/modules/traits/pages/openapi.adoc similarity index 98% rename from docs/modules/ROOT/pages/traits/openapi.adoc rename to docs/modules/traits/pages/openapi.adoc index d1193ab..8d455cf 100755 --- a/docs/modules/ROOT/pages/traits/openapi.adoc +++ b/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 b/docs/modules/traits/pages/owner.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/owner.adoc rename to docs/modules/traits/pages/owner.adoc diff --git a/docs/modules/ROOT/pages/traits/platform.adoc b/docs/modules/traits/pages/platform.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/platform.adoc rename to docs/modules/traits/pages/platform.adoc diff --git a/docs/modules/ROOT/pages/traits/prometheus.adoc b/docs/modules/traits/pages/prometheus.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/prometheus.adoc rename to docs/modules/traits/pages/prometheus.adoc diff --git a/docs/modules/ROOT/pages/traits/pull-secret.adoc b/docs/modules/traits/pages/pull-secret.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/pull-secret.adoc rename to docs/modules/traits/pages/pull-secret.adoc diff --git a/docs/modules/ROOT/pages/traits/quarkus.adoc b/docs/modules/traits/pages/quarkus.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/quarkus.adoc rename to docs/modules/traits/pages/quarkus.adoc diff --git a/docs/modules/ROOT/pages/traits/route.adoc b/docs/modules/traits/pages/route.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/route.adoc rename to docs/modules/traits/pages/route.adoc diff --git a/docs/modules/ROOT/pages/traits/service.adoc b/docs/modules/traits/pages/service.adoc similarity index 100% rename from docs/modules/ROOT/pages/traits/service.adoc rename to docs/modules/traits/pages/service.adoc diff --git a/docs/modules/ROOT/pages/traits/traits.adoc b/docs/modules/traits/pages/traits.adoc similarity index 55% rename from docs/modules/ROOT/pages/traits/traits.adoc rename to docs/modules/traits/pages/traits.adoc index e2e663c..8f3a999 100644 --- a/docs/modules/ROOT/pages/traits/traits.adoc +++ b/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 index ff10afb..51802bc 100644 --- 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" } } diff --git a/docs/yarn.lock b/docs/yarn.lock index 81dbfd3..c842c7e 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -9,26 +9,26 @@ dependencies: asciidoctor.js "1.5.9" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/asciidoc-loader/-/asciidoc-loader-2.3.0.tgz#e9917dd0a61ede76b337f32ac59abc27d3398f8f"; - integrity sha512-mncSlmkk6rYH5SGplZtHjuieG3ve5bhm4x0f9WIFE+GhqajIogDjxTBNWNr9B2dVA4bMves7Sy+c5h+f9V3iVw== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/asciidoc-loader/-/asciidoc-loader-2.3.1.tgz#4e7bb806f0b8592b04a9d621b0ef465d21148ad6"; + integrity sha512-YSf5oEExzrR+O7FizQAeIYyP/BAGvhGw9inACFF3Er3fzCR/sOvPadT6a/slW//tVGLF3eul0ARvw7QAvo6yHQ== dependencies: asciidoctor.js "1.5.9" opal-runtime "1.0.11" -"@antora/cli@~2.3.0": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/cli/-/cli-2.3.0.tgz#e8bc5509fa7742249c338ec49ad28582c3765e35"; - integrity sha512-YiAP7Ib4zhAE+owOKg1/cJ+1AQX4BGfvaMnGkHaSf6srutoLLCRIbD0InpSNobf+ouSMqqk6fiLmBVt/cu03og== +"@antora/cli@~2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/cli/-/cli-2.3.1.tgz#344ba6ab00cd9106da734ab85b791098ab114aa6"; + integrity sha512-AtqlCYdlvwfRUtqaSzjR3Ji4WpCHq/AyD+rcagD3lg/WGiZdwgppiy4Oj36s7rUfR0SDl5GIIWmA5zdDSBRNvw== dependencies: - "@antora/playbook-builder" "2.3.0" - commander "~5.0" + "@antora/playbook-builder" "2.3.1" + commander "~5.1" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/content-aggregator/-/content-aggregator-2.3.0.tgz#a2a2d0d38b4ebb65cef834aa510ac01fe131fa2b"; - integrity sha512-LbH65Hw5uk3QCX8sCsJGnIVapQbtkxgyaDAfxYJlXnBI4jjd92391k0vitFL7f+9dzEvSdzxUHJU/lPyi9eB6g== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/content-aggregator/-/content-aggregator-2.3.1.tgz#c811a56207982c77a37353799b342045e651ebcb"; + integrity sha512-DKrM7FtK5ivWHmQjMkPYkn3S4jQ9Sy6QiNfKYcg/EcIee5k3VPRjYHn40nPY0gS+R4zElRJhru6bHOpnkGJYVA== dependencies: "@antora/expand-path-helper" "~1.0" braces "~3.0" @@ -63,12 +63,12 @@ vinyl "^2.2.0" vinyl-fs "^3.0.3" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/content-classifier/-/content-classifier-2.3.0.tgz#c0312b739a30346b6c06a664043a7627ffbbaa1f"; - integrity sha512-x/GUrm62+zSA8uQYaPG1y8NDALSDeKKl+um0CrxV5nt8c6vEO80KODN4YEPqoC0tOq8zdT99J6ElYblpkxrW6Q== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/content-classifier/-/content-classifier-2.3.1.tgz#c1702f036a3a4c0f8a8f15d13d644e72707e2818"; + integrity sha512-d9vfhxcJY8DdU43h93cK96/Te2eKcJeA4pCljQrRUFpguZndMVrmWMxp8wzOYYSMIIukwcZVa3AISz86RNvrYA== dependencies: - "@antora/asciidoc-loader" "2.3.0" + "@antora/asciidoc-loader" "2.3.1" vinyl "~2.2" "@antora/content-classifier@~2.0": @@ -79,12 +79,12 @@ lodash "^4.17.11" vinyl "^2.2.0" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/document-converter/-/document-converter-2.3.0.tgz#ac6c4a659bcc573806469949ecf75bf6c4570506"; - integrity sha512-RMvdqBIz+pXf5znuyVeR7GF8qw/zLfaRMmEzMzywYa+8Cappxy+pgs+BuAuH1TdAnsFzpPrIO211c2FE1OxXBg== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/document-converter/-/document-converter-2.3.1.tgz#d150b7bc252fa6ce7f63d88f2a9fcdd6341a39d4"; + integrity sha512-5vnr3twkunAkv04NaqgLtXQTTlRNsvTo/jpVrUQ6DNQHE3l3Sr0z/6u4GWkueI95L/PFlFQ79WUNsBPLICfLrA== dependencies: - "@antora/asciidoc-loader" "2.3.0" + "@antora/asciidoc-loader" "2.3.1" "@antora/document-converter@~2.0": version "2.0.0" @@ -98,30 +98,29 @@ resolved "https://registry.yarnpkg.com/@antora/expand-path-helper/-/expand-path-helper-1.0.0.tgz#3bfd6938ab86d4709af8d869cbf3bb17b8fe8912"; integrity sha512-hg3y6M3OvRTb7jtLAnwwloYDxafbyKYttcf16kGCXvP7Wqosh7c+Ag+ltaZ7VSebpzpphO/umb/BXdpU7rxapw== -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/navigation-builder/-/navigation-builder-2.3.0.tgz#b94bc0eb48d373ca3308ad9265cb07315e7965c3"; - integrity sha512-bpdT50pUW8IbRHAwlwaRdMlqwdTCOGdh0novW2Z6uBi6KKKbl6K3BdbaVs/jwXalESWqkYHcyBpinMivsX4bBA== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/navigation-builder/-/navigation-builder-2.3.1.tgz#7ebfae0727b64cb099b883f02aaa18fddfa633ce"; + integrity sha512-kWsi/wn/+IEljBdR6dSE6TFrF+KUfOlDQTnq9YmMzdUCLJRk7Cvz36zsbDFRE8cgqkuunddfsA6oOECgXLQyrw== dependencies: - "@antora/asciidoc-loader" "2.3.0" + "@antora/asciidoc-loader" "2.3.1" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/page-composer/-/page-composer-2.3.0.tgz#1446934f4ae033b8230aac6f2f08b3270f7613b1"; - integrity sha512-ve4h3uColNuqGehSJ2qUw5dar1Ls3i+RBYh2HyVZZ84qjLoOjPGAALFYzRVJnYlEX6nAswNFhh5ll/hIuaxuHQ== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/page-composer/-/page-composer-2.3.1.tgz#a81dda7c5de69e9225297b068f11297485814416"; + integrity sha512-HVZR5GgF+aA41Y0FVOmRHkI5Hn+ab4giJ5FvKwMZlqF10zd0u+rne6+0664kC08wYUIr40/OMayCRgIHPqEwuQ== dependencies: handlebars "~4.7" require-from-string "~2.0" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/playbook-builder/-/playbook-builder-2.3.0.tgz#b43bcd5fe5d3dc506082a821e9a161f61ffa5b7c"; - integrity sha512-zuuTqY5dDXYhu4LfmFW3qzdFXSrXSo9NCDX9eBJ6MCXsuj64PqdOljzv4rWNy3HvmKOSCupfWCashJS0vuH2Dw== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/playbook-builder/-/playbook-builder-2.3.1.tgz#b93f530594e7bb6a465202328f5bba8d1495fbb8"; + integrity sha512-/gl4H/0ey/Uc80GaomZoz10c/f8TX4bQ70SR+BlKrwjwsHCskfffVa+jvMAjnOlP0SGEPwIGkifWPGQbTHdH7A== dependencies: "@iarna/toml" "~2.2" camelcase-keys "~6.2" convict "~5.2" - deep-freeze-node "~1.1" js-yaml "~3.13" json5 "~2.1" @@ -137,43 +136,43 @@ js-yaml "^3.12.0" json5 "^2.1.0" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/redirect-producer/-/redirect-producer-2.3.0.tgz#0a0516cde38ba97f339182553d99842aa6a95719"; - integrity sha512-/632VZlkpFIh5KlV3A9LqE4yGtYyQ+1vOb5A9yajYWsCnhqNfEMslMWuoLoQk4gzs3Ju+hz5MrAXp8sn1vbRvg== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/redirect-producer/-/redirect-producer-2.3.1.tgz#9030fab6afd3659c199866ac3b662492c5b7bb4d"; + integrity sha512-2iDYwygpZ5xHrSflnDIn+kzLt+9jXKOTRHXXqCQHYZuHANQVEYLI93yOXivvFZZvX/jaRzZBF7uTI3FGwg2Isw== dependencies: - "@antora/asciidoc-loader" "2.3.0" + "@antora/asciidoc-loader" "2.3.1" vinyl "~2.2" -"@antora/site-generator-default@~2.3.0": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/site-generator-default/-/site-generator-default-2.3.0.tgz#ec011218d99639dd5f88a402f797c3e892531b95"; - integrity sha512-swDQeAEnC/ClmhHJ50UNJppUSAneOp2cHwZiRr3zUQ9+5+mvOrDEdHbyxH7mIwkoeiIcQ/UVw00bg4MwmQ0M0g== - dependencies: - "@antora/asciidoc-loader" "2.3.0" - "@antora/content-aggregator" "2.3.0" - "@antora/content-classifier" "2.3.0" - "@antora/document-converter" "2.3.0" - "@antora/navigation-builder" "2.3.0" - "@antora/page-composer" "2.3.0" - "@antora/playbook-builder" "2.3.0" - "@antora/redirect-producer" "2.3.0" - "@antora/site-mapper" "2.3.0" - "@antora/site-publisher" "2.3.0" - "@antora/ui-loader" "2.3.0" - -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/site-mapper/-/site-mapper-2.3.0.tgz#08c75114e679512f4298db34709836fd38c779a9"; - integrity sha512-XzIoYKJQXgOzsDeUlL/edVR9B9aaCYUHADvzYqDc1S5/czFQxpqIIgMfYCiYYc7pHk6nmj5rgx/6HfvDImv87w== - dependencies: - "@antora/content-classifier" "2.3.0" +"@antora/site-generator-default@~2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/site-generator-default/-/site-generator-default-2.3.1.tgz#5afe6c2060a111b55be32a43ec2944fc486e15b4"; + integrity sha512-uAt6pCfMfTs2m+IUZjcivN4fDmt2D3C2lI9dfWAkAe2P9vIY7oZuVqCuBQfAwnkJg8mOTk0J2gLEyspbRDsK7w== + dependencies: + "@antora/asciidoc-loader" "2.3.1" + "@antora/content-aggregator" "2.3.1" + "@antora/content-classifier" "2.3.1" + "@antora/document-converter" "2.3.1" + "@antora/navigation-builder" "2.3.1" + "@antora/page-composer" "2.3.1" + "@antora/playbook-builder" "2.3.1" + "@antora/redirect-producer" "2.3.1" + "@antora/site-mapper" "2.3.1" + "@antora/site-publisher" "2.3.1" + "@antora/ui-loader" "2.3.1" + +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/site-mapper/-/site-mapper-2.3.1.tgz#b00af5e9ad37e6d024f156f42ca8c8a559854b83"; + integrity sha512-EkHEEPz0CfLJuE8lx6s9b8+jEC8krFN29zAqK6WaOTi34Tqhv5H/W14mk7IJfy8nWjIjZgP/q/a8gJK9LegYaw== + dependencies: + "@antora/content-classifier" "2.3.1" vinyl "~2.2" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/site-publisher/-/site-publisher-2.3.0.tgz#16f66d0133cee5cb2d77e806e9c58817c7e45a45"; - integrity sha512-2qC0fDE70VKtyttPpRx9glPWL4M5x7HYVCs1K6+GmpuISmljO3c/09L+ExPsJiSVVFarnWmMu0w+76XqSRHlog== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/site-publisher/-/site-publisher-2.3.1.tgz#e590224b295b5b2df521e01f9f886033bbc1f42b"; + integrity sha512-s42S+e3IF5qLgL7N42LpcGc2+UcsJBrY9B10fUP0WQFM51LsNWIwQmU3EheoSEUjo5JvQYi5vlQsHlb7j8TCPA== dependencies: "@antora/expand-path-helper" "~1.0" fs-extra "~8.1" @@ -181,10 +180,10 @@ vinyl "~2.2" vinyl-fs "~3.0" -"@antora/[email protected]": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@antora/ui-loader/-/ui-loader-2.3.0.tgz#3282e28576234d9ad7ad135188c1e2a82640ed33"; - integrity sha512-EcBUwd4ImWI/BH0dZpH6CfDzBnAtQ2qUPChaeqVbmfCNpBvH6t09YYRVA713no21ypAF3AwBs3FGU1+vR6T/IQ== +"@antora/[email protected]": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@antora/ui-loader/-/ui-loader-2.3.1.tgz#cfffa326c455ec05b2017390d61b5807e18d2b8f"; + integrity sha512-0uZDixaamnMnGJvl1M5bqW2ac8+6W2KZcfOTwPBEJJCLTGiZe4GASB+zR7tXNyrUr51zLuCjxPNcEbzGEfRxAQ== dependencies: "@antora/expand-path-helper" "~1.0" bl "~4.0" @@ -216,6 +215,13 @@ dependencies: regenerator-runtime "^0.13.2" +"@djencks/asciidoctor-antora-indexer@^0.0.2": + version "0.0.2" + resolved "https://registry.yarnpkg.com/@djencks/asciidoctor-antora-indexer/-/asciidoctor-antora-indexer-0.0.2.tgz#ad1a14b3a58895a2202e456e24ec039fa9da43d3"; + integrity sha512-1PhltF2Pfj8CrcV3BWe52bG+iZ1BKe1DJSk1EXM56Yn7hFoCnLfvA7i2b+NQy6wIjMwTVM5LVrv2sl50LF4EFQ== + dependencies: + picomatch "~2.1" + "@iarna/toml@^2.2.1": version "2.2.3" resolved "https://registry.yarnpkg.com/@iarna/toml/-/toml-2.2.3.tgz#f060bf6eaafae4d56a7dac618980838b0696e2ab"; @@ -803,10 +809,10 @@ commander@~2.20.3: resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"; integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== -commander@~5.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/commander/-/commander-5.0.0.tgz#dbf1909b49e5044f8fdaf0adc809f0c0722bdfd0"; - integrity sha512-JrDGPAKjMGSP1G0DUoaceEJ3DZgAfr/q6X7FVk4+U5KxUSKviYGM2k6zWkfyyBHy5rAtzgYJFa1ro2O9PtoxwQ== +commander@~5.1: + version "5.1.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-5.1.0.tgz#46abbd1652f8e059bddaef99bbdcb2ad9cf179ae"; + integrity sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg== [email protected]: version "1.0.0" @@ -944,11 +950,6 @@ deep-extend@^0.6.0: resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac"; integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== -deep-freeze-node@~1.1: - version "1.1.3" - resolved "https://registry.yarnpkg.com/deep-freeze-node/-/deep-freeze-node-1.1.3.tgz#ce9c14b3210e6f5607a578254f4b53fe01dd9467"; - integrity sha512-CrA+1BVGfs9ZrGFMYtHfFHncWivh9XPb+6g8bLOzYPJmW8FmUs1dXLjALzU1SMqOMdoD5pQJARXtzxfeLqE9HQ== - deep-freeze@^0.0.1: version "0.0.1" resolved "https://registry.yarnpkg.com/deep-freeze/-/deep-freeze-0.0.1.tgz#3a0b0005de18672819dfd38cd31f91179c893e84"; @@ -2787,6 +2788,11 @@ pend@~1.2.0: resolved "https://registry.yarnpkg.com/pend/-/pend-1.2.0.tgz#7a57eb550a6783f9115331fcf4663d5c8e007a50"; integrity sha1-elfrVQpng/kRUzH89GY9XI4AelA= +picomatch@~2.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.1.1.tgz#ecdfbea7704adb5fe6fb47f9866c4c0e15e905c5"; + integrity sha512-OYMyqkKzK7blWO/+XZYP6w8hH0LDvkBvdvKukti+7kqYFCiEAk+gI3DWnryapc0Dau05ugGTy0foQ6mqn4AHYA== + picomatch@~2.2: version "2.2.2" resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.2.2.tgz#21f333e9b6b8eaff02468f5146ea406d345f4dad";
