All Downloads are FREE. Search and download functionalities are using the official Maven repository.

lidon-docs.4.1.1.source-code.sitegen.yaml Maven / Gradle / Ivy

The newest version!
#
# Copyright (c) 2018, 2024 Oracle and/or its affiliates.
#
# Licensed 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.
#

options:
  strict-xref: true
  fail-on: "WARN"
  strict-templates: true
  strict-images: true
engine:
  asciidoctor:
    images-dir: "/images"
assets:
  - target: "/"
    includes:
      - "css/*.css"
  - target: "/"
    includes:
      - "images/**/*"
header:
  favicon:
    path: "/images/favicon.png"
    type: "png"
  stylesheets:
    - path: "/css/styles.css"
pages:
    - includes:
        - "**/*.adoc"
      excludes:
        - "includes/**"
backend:
    name: "vuetify"
    homePage: "about/doc_overview.adoc"
    releases:
        - "${project.version}"
    navigation:
      type: "ROOT"
      title: "Helidon"
      glyph:
        type: "image"
        value: "/images/helidon_logo_dark.svg"
      items:
        - type: "PAGE"
          title: "Helidon Documentation"
          source: "about/doc_overview.adoc"
          glyph:
            type: "icon"
            value: "lightbulb"
        - type: "PAGE"
          title: "Get Started"
          source: "about/prerequisites.adoc"
          glyph:
            type: "icon"
            value: "rocket_launch"
        - type: "GROUPS"
          items:
          - type: "GROUP"
            title: "Helidon MP"
            dir: "mp"
            items:
              - type: "PAGE"
                title: "Introduction"
                source: "introduction.adoc"
                glyph:
                  type: "icon"
                  value: "lightbulb"
              - type: "MENU"
                title: "Guides"
                dir: "guides"
                glyph:
                  type: "icon"
                  value: "explore"
                sources:
                  - "overview.adoc"
                  - "quickstart.adoc"
                  - "config.adoc"
                  - "health.adoc"
                  - "metrics.adoc"
                  - "security-oidc.adoc"
                  - "tracing.adoc"
                  - "mp-tutorial.adoc"
                  - "upgrade_4x.adoc"
                  - "maven-build.adoc"
                  - "gradle-build.adoc"
                  - "graalnative.adoc"
                  - "jlink-image.adoc"
                  - "se-services.adoc"
                  - "testing-junit5.adoc"
                  - "jbatch.adoc"
                  - "performance-tuning.adoc"
              - type: "PAGE"
                title: "Bean Validation"
                source: "beanvalidation.adoc"
                glyph:
                  type: "icon"
                  value: "receipt"
              - type: "MENU"
                title: "Config"
                dir: "config"
                glyph:
                  type: "icon"
                  value: "settings"
                sources:
                  - "introduction.adoc"
                  - "advanced-configuration.adoc"
              - type: "PAGE"
                title: "CORS"
                source: "cors/cors.adoc"
                glyph:
                  type: "icon"
                  value: "share"
              - type: "PAGE"
                title: "Fault Tolerance"
                source: "fault-tolerance.adoc"
                glyph:
                  type: "icon"
                  value: "warning"
              - type: "PAGE"
                title: "GraphQL Server"
                source: "graphql.adoc"
                glyph:
                  type: "icon"
                  value: "graphic_eq"
              - type: "MENU"
                title: "gRPC"
                dir: "grpc"
                glyph:
                  type: "icon"
                  value: "swap_horiz"
                sources:
                  - "server.adoc"
                  - "client.adoc"
              - type: "PAGE"
                title: "Health Checks"
                source: "health.adoc"
                glyph:
                  type: "icon"
                  value: "favorite_outline"
              - type: "MENU"
                title: "Integrations"
                dir: "integrations"
                glyph:
                  type: "icon"
                  value: "filter_drama"
                sources:
                  - "oci.adoc"
                  - "hcv.adoc"
                  - "neo4j.adoc"
              - type: "MENU"
                title: "JAX-RS/Jersey"
                dir: "jaxrs"
                glyph:
                  type: "icon"
                  value: "settings_ethernet"
                sources:
                  - "application-configuration.adoc"
                  - "jaxrs-applications.adoc"
                  - "jaxrs-client.adoc"
                  - "helidon-connector.adoc"
              - type: "PAGE"
                title: "JWT"
                source: "jwt.adoc"
                glyph:
                  type: "icon"
                  value: "verified_user"
              - type: "PAGE"
                title: "Long Running Actions (LRA)"
                source: "lra.adoc"
                glyph:
                  type: "icon"
                  value: "pending_actions"
              - type: "MENU"
                title: "Metrics"
                dir: "metrics"
                glyph:
                  type: "icon"
                  value: "av_timer"
                sources:
                  - "metrics.adoc"
                  - "prometheus-exemplar-support.adoc"
              - type: "PAGE"
                title: "Observability"
                source: "observability.adoc"
                glyph:
                  type: "icon"
                  value: "search"
              - type: "MENU"
                title: "OpenAPI"
                dir: "openapi"
                glyph:
                  type: "icon"
                  value: "donut_large"
                sources:
                  - "openapi.adoc"
                  - "openapi-generator.adoc"
                  - "openapi-ui.adoc"
              - type: "PAGE"
                title: "Persistence"
                source: "persistence.adoc"
                glyph:
                  type: "icon"
                  value: "dns"
              - type: "MENU"
                title: "Reactive Messaging"
                dir: "reactivemessaging"
                glyph:
                  type: "icon"
                  value: "message"
                sources:
                  - "introduction.adoc"
                  - "kafka.adoc"
                  - "jms.adoc"
                  - "aq.adoc"
                  - "weblogic.adoc"
                  - "mock.adoc"
              - type: "MENU"
                title: "Reactive Streams"
                dir: "reactivestreams"
                glyph:
                  type: "icon"
                  value: "waves"
                sources:
                  - "engine.adoc"
                  - "rsoperators.adoc"
              - type: "PAGE"
                title: "REST Client"
                source: "restclient.adoc"
                glyph:
                  type: "icon"
                  value: "airplay"
              - type: "PAGE"
                title: "Scheduling"
                source: "scheduling.adoc"
                glyph:
                  type: "icon"
                  value: "access_alarm"
              - type: "PAGE"
                title: "Threading"
                source: "threading.adoc"
                glyph:
                  type: "icon"
                  value: "clear_all"
              - type: "MENU"
                title: "Security"
                dir: "security"
                glyph:
                  type: "icon"
                  value: "security"
                sources:
                  - "security.adoc"
                  - "providers.adoc"
                  - "configuration-secrets.adoc"
                  - "jep-290.adoc"
              - type: "PAGE"
                title: "Server"
                source: "server.adoc"
                glyph:
                  type: "icon"
                  value: "settings_ethernet"
              - type: "PAGE"
                title: "Telemetry"
                source: "telemetry.adoc"
                glyph:
                  type: "icon"
                  value: "analytics"
              - type: "MENU"
                title: "Testing"
                dir: "testing"
                glyph:
                  type: "icon"
                  value: "thumbs_up_down"
                sources:
                  - "testing.adoc"
                  - "testing-ng.adoc"
              - type: "PAGE"
                title: "Tracing"
                source: "tracing.adoc"
                glyph:
                  type: "icon"
                  value: "timeline"
              - type: "PAGE"
                title: "Websocket"
                source: "websocket.adoc"
                glyph:
                  type: "icon"
                  value: "sync_alt"
          - type: "GROUP"
            title: "Helidon SE"
            dir: "se"
            items:
              - type: "PAGE"
                title: "Introduction"
                source: "introduction.adoc"
                glyph:
                  type: "icon"
                  value: "lightbulb"
              - type: "MENU"
                title: "Guides"
                dir: "guides"
                glyph:
                  type: "icon"
                  value: "explore"
                sources:
                  - "overview.adoc"
                  - "quickstart.adoc"
                  - "config.adoc"
                  - "health.adoc"
                  - "metrics.adoc"
                  - "security-oidc.adoc"
                  - "tracing.adoc"
                  - "upgrade_4x.adoc"
                  - "maven-build.adoc"
                  - "gradle-build.adoc"
                  - "graalnative.adoc"
                  - "jlink-image.adoc"
                  - "webclient.adoc"
                  - "dbclient.adoc"
                  - "performance-tuning.adoc"
              - type: "MENU"
                title: "Config"
                dir: "config"
                glyph:
                  type: "icon"
                  value: "settings"
                sources:
                  - "introduction.adoc"
                  - "hierarchical-features.adoc"
                  - "property-mapping.adoc"
                  - "supported-formats.adoc"
                  - "config-profiles.adoc"
                  - "mutability-support.adoc"
                  - "advanced-configuration.adoc"
                  - "extensions.adoc"
              - type: "PAGE"
                title: "CORS"
                source: "cors.adoc"
                glyph:
                  type: "icon"
                  value: "share"
              - type: "PAGE"
                title: "DB Client"
                source: "dbclient.adoc"
                glyph:
                  type: "icon"
                  value: "storage"
              - type: "PAGE"
                title: "Fault Tolerance"
                source: "fault-tolerance.adoc"
                glyph:
                  type: "icon"
                  value: "warning"
              - type: "PAGE"
                title: "GraphQL Server"
                source: "graphql.adoc"
                glyph:
                  type: "icon"
                  value: "graphic_eq"
              - type: "MENU"
                title: "gRPC"
                dir: "grpc"
                glyph:
                  type: "icon"
                  value: "swap_horiz"
                sources:
                  - "server.adoc"
                  - "client.adoc"
              - type: "PAGE"
                title: "Health Checks"
                source: "health.adoc"
                glyph:
                  type: "icon"
                  value: "favorite_outline"
              - type: "MENU"
                title: "Integrations"
                dir: "integrations"
                glyph:
                  type: "icon"
                  value: "filter_drama"
                sources:
                  - "oci.adoc"
                  - "hcv.adoc"
                  - "neo4j.adoc"
              - type: "MENU"
                title: "Metrics"
                dir: "metrics"
                glyph:
                  type: "icon"
                  value: "av_timer"
                sources:
                  - "metrics.adoc"
                  - "prometheus-exemplar-support.adoc"
              - type: "MENU"
                title: "OpenAPI"
                dir: "openapi"
                glyph:
                  type: "icon"
                  value: "donut_large"
                sources:
                  - "openapi.adoc"
                  - "openapi-generator.adoc"
                  - "openapi-ui.adoc"
              - type: "PAGE"
                title: "Observability"
                source: "observability.adoc"
                glyph:
                  type: "icon"
                  value: "search"
              - type: "PAGE"
                title: "Reactive Messaging"
                source: "reactive-messaging.adoc"
                glyph:
                  type: "icon"
                  value: "message"
              - type: "MENU"
                title: "Reactive Streams"
                dir: "reactivestreams"
                glyph:
                  type: "icon"
                  value: "waves"
                sources:
                  - "engine.adoc"
                  - "rsoperators.adoc"
              - type: "PAGE"
                title: "Webserver"
                source: "webserver.adoc"
                glyph:
                  type: "icon"
                  value: "settings_ethernet"
              - type: "PAGE"
                title: "Scheduling"
                source: "scheduling.adoc"
                glyph:
                  type: "icon"
                  value: "access_alarm"
              - type: "MENU"
                title: "Security"
                dir: "security"
                glyph:
                  type: "icon"
                  value: "security"
                sources:
                  - "introduction.adoc"
                  - "providers.adoc"
                  - "containers-integration.adoc"
                  - "tools.adoc"
                  - "extensibility.adoc"
                  - "jep-290.adoc"
              - type: "PAGE"
                title: "Server-Sent Events (SSE)"
                source: "sse.adoc"
                glyph:
                  type: "icon"
                  value: "outbox"
              - type: "PAGE"
                title: "Testing"
                source: "testing.adoc"
                glyph:
                  type: "icon"
                  value: "thumbs_up_down"
              - type: "PAGE"
                title: "Tracing"
                source: "tracing.adoc"
                glyph:
                  type: "icon"
                  value: "timeline"
              - type: "PAGE"
                title: "Web Client"
                source: "webclient.adoc"
                glyph:
                  type: "icon"
                  value: "http"
              - type: "PAGE"
                title: "Websocket"
                source: "websocket.adoc"
                glyph:
                  type: "icon"
                  value: "sync_alt"
        - type: "HEADER"
          title: "Additional resources"
        - type: "LINK"
          title: "Javadocs"
          href: "/apidocs/index.html?overview-summary.html"
          glyph:
            type: "icon"
            value: "library_books"
        - type: "PAGE"
          title: "Config Reference"
          source: "config/config_reference.adoc"
          glyph:
            type: "icon"
            value: "library_books"
        - type: "PAGE"
          title: "Community"
          source: "community.adoc"
          glyph:
            type: "icon"
            value: "fa-github"




© 2015 - 2024 Weber Informatics LLC | Privacy Policy