This is an automated email from the ASF dual-hosted git repository. pcongiusti pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 251aa5e57cd9c0fc40ed3f33ba19e5cdc504f48a Author: Pasquale Congiusti <[email protected]> AuthorDate: Fri Sep 15 12:00:28 2023 +0200 chore(doc): rearrange menu --- cmd/util/doc-gen/main.go | 2 +- config/crd/bases/camel.apache.org_builds.yaml | 3 + docs/modules/ROOT/nav-end.adoc | 76 +++++++++++++++++++++-- docs/modules/ROOT/nav.adoc | 69 +------------------- docs/modules/ROOT/partials/apis/camel-k-crds.adoc | 28 ++++----- helm/camel-k/crds/crd-build.yaml | 3 + 6 files changed, 94 insertions(+), 87 deletions(-) diff --git a/cmd/util/doc-gen/main.go b/cmd/util/doc-gen/main.go index fdf2ecce1..d57036ce5 100644 --- a/cmd/util/doc-gen/main.go +++ b/cmd/util/doc-gen/main.go @@ -35,7 +35,7 @@ func main() { pflag.CommandLine.StringVar(&customArgs.DocDir, "doc-dir", "./docs", "Root of the document directory.") pflag.CommandLine.StringVar(&customArgs.ResourceDir, "resource-dir", "./resources", "Root of the resource directory.") pflag.CommandLine.StringVar(&customArgs.TraitPath, "traits-path", "modules/traits/pages", "Path to the traits directory.") - pflag.CommandLine.StringVar(&customArgs.NavPath, "nav-path", "modules/ROOT/nav.adoc", "Path to the navigation file.") + pflag.CommandLine.StringVar(&customArgs.NavPath, "nav-path", "modules/ROOT/nav-end.adoc", "Path to the navigation file.") pflag.CommandLine.StringVar(&customArgs.ListPath, "list-path", "modules/traits/pages/traits.adoc", "Path to the trait list file.") arguments.CustomArgs = customArgs diff --git a/config/crd/bases/camel.apache.org_builds.yaml b/config/crd/bases/camel.apache.org_builds.yaml index f3dca9a57..0da5d5245 100644 --- a/config/crd/bases/camel.apache.org_builds.yaml +++ b/config/crd/bases/camel.apache.org_builds.yaml @@ -435,10 +435,13 @@ spec: servers: description: Servers (auth) items: + description: Server see link:https://maven.apache.org/settings.html[Maven + settings] properties: configuration: additionalProperties: type: string + description: Properties -- type: object id: type: string diff --git a/docs/modules/ROOT/nav-end.adoc b/docs/modules/ROOT/nav-end.adoc index 1f1b100ad..eea1b4cf0 100644 --- a/docs/modules/ROOT/nav-end.adoc +++ b/docs/modules/ROOT/nav-end.adoc @@ -1,12 +1,80 @@ -* Troubleshooting -** xref:troubleshooting/debugging.adoc[Debugging] -** xref:troubleshooting/operating.adoc[Operating] -** xref:troubleshooting/known-issues.adoc[Known Issues] +* xref:configuration/configuration.adoc[Configuration] +** xref:configuration/build-time-properties.adoc[Build time properties] +** xref:configuration/components.adoc[Components] +** xref:configuration/dependencies.adoc[Dependencies] +** xref:configuration/maven-profile.adoc[Maven Profile] +** xref:configuration/runtime-properties.adoc[Properties] +** xref:configuration/runtime-config.adoc[Runtime configuration] +** xref:configuration/runtime-resources.adoc[Runtime resources] * xref:kamelets/kamelets.adoc[Kamelets] ** xref:kamelets/kamelets-distribution.adoc[Distribution] ** xref:kamelets/kamelets-user.adoc[User Guide] ** xref:kamelets/kamelets-dev.adoc[Developer Guide] ** xref:kamelets/kameletbindings-error-handler.adoc[Error Handling] +* 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:aws-secrets-manager.adoc[Aws Secrets Manager] +** xref:traits:azure-key-vault.adoc[Azure Key Vault] +** 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:error-handler.adoc[Error Handler] +** xref:traits:gc.adoc[Gc] +** xref:traits:gcp-secret-manager.adoc[Gcp Secret Manager] +** xref:traits:hashicorp-vault.adoc[Hashicorp Vault] +** xref:traits:health.adoc[Health] +** xref:traits:ingress.adoc[Ingress] +** xref:traits:istio.adoc[Istio] +** xref:traits:jolokia.adoc[Jolokia] +** xref:traits:jvm.adoc[Jvm] +** xref:traits:kamelets.adoc[Kamelets] +** xref:traits:keda.adoc[Keda] +** xref:traits:knative-service.adoc[Knative Service] +** xref:traits:knative.adoc[Knative] +** xref:traits:logging.adoc[Logging] +** xref:traits:master.adoc[Master] +** xref:traits:mount.adoc[Mount] +** xref:traits:openapi.adoc[Openapi] +** xref:traits:owner.adoc[Owner] +** xref:traits:pdb.adoc[Pdb] +** xref:traits:platform.adoc[Platform] +** xref:traits:pod.adoc[Pod] +** xref:traits:prometheus.adoc[Prometheus] +** xref:traits:pull-secret.adoc[Pull Secret] +** xref:traits:quarkus.adoc[Quarkus] +** xref:traits:registry.adoc[Registry] +** xref:traits:resume.adoc[Resume] +** xref:traits:route.adoc[Route] +** xref:traits:service-binding.adoc[Service Binding] +** xref:traits:service.adoc[Service] +** xref:traits:telemetry.adoc[Telemetry] +** xref:traits:toleration.adoc[Toleration] +** xref:traits:tracing.adoc[Tracing] +// End of autogenerated code - DO NOT EDIT! (trait-nav) +* Pipelines +** xref:pipeline/pipeline.adoc[Basic] +** xref:pipeline/tekton.adoc[Tekton] +* Scaling +** xref:scaling/integration.adoc[Integrations] +** xref:scaling/binding.adoc[Pipes] +* Observability +** xref:observability/logging.adoc[Logging] +*** xref:observability/logging/operator.adoc[Operator] +*** xref:observability/logging/integration.adoc[Integration] +** xref:observability/monitoring.adoc[Monitoring] +*** xref:observability/monitoring/operator.adoc[Operator] +*** xref:observability/monitoring/integration.adoc[Integration] +* Troubleshooting +** xref:troubleshooting/debugging.adoc[Debugging] +** xref:troubleshooting/operating.adoc[Operating] +** xref:troubleshooting/known-issues.adoc[Known Issues] * xref:architecture/architecture.adoc[Architecture] ** xref:architecture/operator.adoc[Operator] *** xref:architecture/cr/integration-platform.adoc[IntegrationPlatform] diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 3335fea73..18de9adab 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -23,71 +23,4 @@ ** xref:running/run-from-github.adoc[Run from GitHub] ** xref:running/promoting.adoc[Promote an Integration] ** xref:running/knative-sink.adoc[Knative Sinks] -* xref:configuration/configuration.adoc[Configuration] -** xref:configuration/build-time-properties.adoc[Build time properties] -** xref:configuration/components.adoc[Components] -** xref:configuration/dependencies.adoc[Dependencies] -** xref:configuration/maven-profile.adoc[Maven Profile] -** xref:configuration/runtime-properties.adoc[Properties] -** xref:configuration/runtime-config.adoc[Runtime configuration] -** xref:configuration/runtime-resources.adoc[Runtime resources] -* Pipelines -** xref:pipeline/pipeline.adoc[Basic] -** xref:pipeline/tekton.adoc[Tekton] -* Observability -** xref:observability/logging.adoc[Logging] -*** xref:observability/logging/operator.adoc[Operator] -*** xref:observability/logging/integration.adoc[Integration] -** xref:observability/monitoring.adoc[Monitoring] -*** xref:observability/monitoring/operator.adoc[Operator] -*** xref:observability/monitoring/integration.adoc[Integration] -* Scaling -** xref:scaling/integration.adoc[Integrations] -** xref:scaling/binding.adoc[Pipes] -* 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:aws-secrets-manager.adoc[Aws Secrets Manager] -** xref:traits:azure-key-vault.adoc[Azure Key Vault] -** 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:error-handler.adoc[Error Handler] -** xref:traits:gc.adoc[Gc] -** xref:traits:gcp-secret-manager.adoc[Gcp Secret Manager] -** xref:traits:hashicorp-vault.adoc[Hashicorp Vault] -** xref:traits:health.adoc[Health] -** xref:traits:ingress.adoc[Ingress] -** xref:traits:istio.adoc[Istio] -** xref:traits:jolokia.adoc[Jolokia] -** xref:traits:jvm.adoc[Jvm] -** xref:traits:kamelets.adoc[Kamelets] -** xref:traits:keda.adoc[Keda] -** xref:traits:knative-service.adoc[Knative Service] -** xref:traits:knative.adoc[Knative] -** xref:traits:logging.adoc[Logging] -** xref:traits:master.adoc[Master] -** xref:traits:mount.adoc[Mount] -** xref:traits:openapi.adoc[Openapi] -** xref:traits:owner.adoc[Owner] -** xref:traits:pdb.adoc[Pdb] -** xref:traits:platform.adoc[Platform] -** xref:traits:pod.adoc[Pod] -** xref:traits:prometheus.adoc[Prometheus] -** xref:traits:pull-secret.adoc[Pull Secret] -** xref:traits:quarkus.adoc[Quarkus] -** xref:traits:registry.adoc[Registry] -** xref:traits:resume.adoc[Resume] -** xref:traits:route.adoc[Route] -** xref:traits:service-binding.adoc[Service Binding] -** xref:traits:service.adoc[Service] -** xref:traits:telemetry.adoc[Telemetry] -** xref:traits:toleration.adoc[Toleration] -** xref:traits:tracing.adoc[Tracing] -// End of autogenerated code - DO NOT EDIT! (trait-nav) + diff --git a/docs/modules/ROOT/partials/apis/camel-k-crds.adoc b/docs/modules/ROOT/partials/apis/camel-k-crds.adoc index c5dba1aa0..7eb00c80f 100644 --- a/docs/modules/ROOT/partials/apis/camel-k-crds.adoc +++ b/docs/modules/ROOT/partials/apis/camel-k-crds.adoc @@ -339,7 +339,7 @@ Generic raw message, typically a map containing the keys (trait parameters) and * <<#_camel_apache_org_v1_Container, Container>> - +Args -- [cols="2,2a",options="header"] |=== @@ -1400,7 +1400,7 @@ the value to assign to the configuration (syntax may vary depending on the `Type * <<#_camel_apache_org_v1_PluginConfiguration, PluginConfiguration>> - +Container -- [cols="2,2a",options="header"] |=== @@ -1913,7 +1913,7 @@ string * <<#_camel_apache_org_v1_PluginConfiguration, PluginConfiguration>> - +ExtraDirectories -- [cols="2,2a",options="header"] |=== @@ -2021,7 +2021,7 @@ time of the attempt execution * <<#_camel_apache_org_v1_PluginExtensionConfiguration, PluginExtensionConfiguration>> - +Filter -- [cols="2,2a",options="header"] |=== @@ -4049,7 +4049,7 @@ See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html. * <<#_camel_apache_org_v1_ExtraDirectories, ExtraDirectories>> - +Path -- [cols="2,2a",options="header"] |=== @@ -4087,7 +4087,7 @@ string * <<#_camel_apache_org_v1_ExtraDirectories, ExtraDirectories>> - +Permission -- [cols="2,2a",options="header"] |=== @@ -4318,7 +4318,7 @@ Selector allows to identify pods belonging to the pipe [#_camel_apache_org_v1_PluginConfiguration] === PluginConfiguration - +PluginConfiguration see link:https://maven.apache.org/settings.html[Maven settings] [cols="2,2a",options="header"] |=== @@ -4363,7 +4363,7 @@ string * <<#_camel_apache_org_v1_PluginExtensions, PluginExtensions>> - +PluginExtension -- [cols="2,2a",options="header"] |=== @@ -4394,7 +4394,7 @@ string * <<#_camel_apache_org_v1_PluginExtension, PluginExtension>> - +PluginExtensionConfiguration -- [cols="2,2a",options="header"] |=== @@ -4425,7 +4425,7 @@ string * <<#_camel_apache_org_v1_PluginConfiguration, PluginConfiguration>> - +PluginExtensions -- [cols="2,2a",options="header"] |=== @@ -4445,7 +4445,7 @@ string [#_camel_apache_org_v1_PluginProperties] === PluginProperties(`map[string]github.com/apache/camel-k/v2/pkg/apis/camel/v1.StringOrProperties` alias) - +PluginProperties -- [#_camel_apache_org_v1_PodCondition] @@ -4613,7 +4613,7 @@ the specification * <<#_camel_apache_org_v1_Server, Server>> * <<#_camel_apache_org_v1_StringOrProperties, StringOrProperties>> - +Properties -- [#_camel_apache_org_v1_PublishTask] @@ -4955,7 +4955,7 @@ used by the ImageStream * <<#_camel_apache_org_v1_MavenBuildSpec, MavenBuildSpec>> - +Server see link:https://maven.apache.org/settings.html[Maven settings] [cols="2,2a",options="header"] |=== @@ -5109,7 +5109,7 @@ SpectrumTask is used to configure Spectrum. [#_camel_apache_org_v1_StringOrProperties] === StringOrProperties - +StringOrProperties -- [cols="2,2a",options="header"] |=== diff --git a/helm/camel-k/crds/crd-build.yaml b/helm/camel-k/crds/crd-build.yaml index f3dca9a57..0da5d5245 100644 --- a/helm/camel-k/crds/crd-build.yaml +++ b/helm/camel-k/crds/crd-build.yaml @@ -435,10 +435,13 @@ spec: servers: description: Servers (auth) items: + description: Server see link:https://maven.apache.org/settings.html[Maven + settings] properties: configuration: additionalProperties: type: string + description: Properties -- type: object id: type: string
