antora-playbook-local.yml

site:
  title: Documentation
  start_page: home::index.adoc
  url: http:localhost:3000
  keys:
    docsearch_id: 'QK2EAH8GB0'
    docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
    docsearch_index: 'prod_hazelcast_docs'
    ai_search_id: 'ad664bf0-07e2-42e7-9150-2e1b04b15cca'
content:
  sources:
    - url: .
      start_paths: [home, tutorials, templates]
      branches: HEAD
    - url: https://github.com/hazelcast/hz-docs
      branches: [main, v/*]
      start_path: docs
    - url: https://github.com/hazelcast/hz-flow-docs
      branches: [main]
      start_path: docs
    - url: https://github.com/hazelcast/imdg-docs
      branches: [v/*]
      start_path: docs
    - url: https://github.com/hazelcast/imdg-docs
      branches: [archived-versions]
      start_paths: docs/*
    - url: https://github.com/hazelcast/management-center-docs
      branches: [main, v/*]
      start_path: docs
    - url: https://github.com/hazelcast/management-center-docs
      branches: [archived-versions]
      start_paths: docs/*
    - url: https://github.com/hazelcast/clc-docs
      branches: [v/*]
      start_path: docs
    - url: https://github.com/hazelcast/hazelcast-platform-operator-docs
      branches: [main, v/*]
      start_path: docs
    - url: https://github.com/hazelcast-guides/user-code-namespaces
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/cpsubsystem
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/stream-processing-fundamentals
      branches: main
      start_path: docs
    - url: https://github.com/hazelcast-guides/airline-connections
      branches: main
      start_path: docs
    - url: https://github.com/hazelcast-guides/Generating-Data-using-SQL
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/sql_stock_ticker_cloud
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/Stream-Processing-Intro
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast/cloud-docs
      branches: [main]
      start_paths: [docs, tutorials]
    - url: https://github.com/hazelcast-guides/client-failover
      branches: master
      start_paths: docs
    - url: https://github.com/hazelcast-guides/spring-boot-sample
      branches: master
      start_paths: docs
    - url: https://github.com/hazelcast-guides/serverless-fraud-detection
      branches: master
      start_paths: docs
    - url: https://github.com/hazelcast-guides/write-through-cache-mongodb-mapstore
      branches: master
      start_paths: docs
    - url: https://github.com/hazelcast-guides/standard-deviation-parallel-processing
      branches: master
      start_paths: docs
    - url: https://github.com/hazelcast-guides/stream-to-stream-joins
      branches: master
      start_paths: docs
    - url: https://github.com/hazelcast/hazelcast-cloud-maven-plugin
      branches: main
      start_path: docs
    - url: https://github.com/hazelcast-guides/caching-springboot-jcache
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-embedded-springboot
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/springboot-hibernate
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hibernate-jcache
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/istio
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/caching-micronaut
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/kubernetes-embedded
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-embedded-microprofile
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-client-quarkus
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/springboot-webfilter-session-replication
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/caching-springboot
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/ecs-embedded
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/springboot-tomcat-session-replication
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/terraform-quickstarts
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/kubernetes-external-client
      branches: main
      start_path: docs
    - url: https://github.com/hazelcast-guides/active-directory-authentication
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/kubernetes-sidecar
      branches: main
      start_path: docs
    - url: https://github.com/hazelcast-guides/kubernetes-hpa
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/kubernetes-ssl
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/kubernetes-wan
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/kubernetes
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/spring-session-hazelcast
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/ec2-cluster
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/Hazelcast-Embedded-with-Eureka-discovery
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/linkerd
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/consul
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/openfaas-hz-client
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-expose-externally
      branches: main
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-external-backup-restore
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-wan-replication
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-wan-sync
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-jet
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-jet-job-snapshot
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-tls
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/hazelcast-platform-operator-user-code-namespace
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/kafka-kerberos
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/serverless-trade-monitor-dashboard
      branches: master
      start_path: docs
      #    Uncomment to build Swagger docs locally
      #    These are private repos. You need to do private repository authentication.
      #    See [here](https://docs.antora.org/antora/latest/playbook/private-repository-auth/) how to do that
      #    The easiest way is to use a GitHub token like https://{TOKEN}:@github.com/hazelcast/hazelcast-mono
      #    - url: https://github.com/hazelcast/hazelcast-mono
      #      branches: [master]
      #      start_path: docs/rest
      #    - url: https://github.com/hazelcast/management-center
      #      branches: [master, 5.1.4, 5.2.1, 5.3.4, 5.4.1, 5.5.2, 5.6.0]
      #      start_path: antora
    - url: https://github.com/hazelcast-guides/csharp-client-getting-started
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/python-client-getting-started
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/java-client-getting-started
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/nodejs-client-getting-started
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/go-client-getting-started
      branches: master
      start_path: docs
    - url: https://github.com/hazelcast-guides/cpp-client-getting-started
      branches: master
      start_path: docs
ui:
  bundle:
    url: https://github.com/hazelcast/hazelcast-docs-ui/releases/latest/download/ui-bundle.zip
    snapshot: true
antora:
  extensions:
    - require: ./lib/api_json.js
      tags:
        - Favorites
        - Videos
        - Get Started
        - Whitepapers
        - Use cases
        - Case studies
        - Documentation
        - Develop Applications
        - Organizations and Accounts
        - Manage Accounts
        - Manage Organizations
        - Manage Clusters
      data:
        - title: What is a client?
          url: https://www.youtube.com/embed/lkQEAdgxvbE
          type: video
          order: 8
          tags: Videos, Get Started
        - title: What is the Hazelcast Platform?
          url: https://www.youtube.com/embed/UpIgHzKbMp0
          type: video
          order: 9
          tags: Videos, Get Started
asciidoc:
  attributes:
    # Order the products in the version selector dropdown.
    # Use * to list all remaining products in alphabetical order.
    page-component-order: 'hazelcast, management-center, cloud, *'
    page-pagination: true@
    # Allows us to use UI macros. See https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/
    page-experimental: true
    idprefix: ''
    idseparator: '-'
    imdg-javadoc: https://docs.hazelcast.org/docs/latest-dev/javadoc
    imdg-samples: https://github.com/hazelcast/hazelcast-code-samples
    imdg-core: https://github.com/hazelcast/hazelcast/tree/master/hazelcast/src/main/java/com/hazelcast
    imdg-docs: https://docs.hazelcast.org/docs/latest/manual/html-single/index.html
    imdg-ops-guide: https://hazelcast.com/resources/hazelcast-deployment-operations-guide/
    jet-docs: https://jet-start.sh/
    docs-archive: 'https://hazelcast.org/imdg/download/archives/'
    hazelcast-cloud: Cloud
    page-cloud-console: https://cloud.hazelcast.com/
    ucn: User Code Namespaces
    ucd: User Code Deployment
  extensions:
    - ./lib/tabs-block.js
    - ./lib/swagger-ui-block-macro.js
    - asciidoctor-kroki