antora.yml

---
name: docs
title: Documentation
version: next
prerelease: true
start_page: overview:introduction-to-eclipse-che.adoc
nav:
  - modules/overview/nav.adoc
  - modules/hosted-che/nav.adoc
  - modules/end-user-guide/nav.adoc
  - modules/administration-guide/nav.adoc
  - modules/extensions/nav.adoc
  - modules/glossary/nav.adoc
asciidoc:
  attributes:
    # for antora
    context: che
    experimental: ""
    favicon: favicon.png
    icons: font
    ocp: OpenShift Container Platform
    # recommended OCP version for new deployments
    # included in links to OCP docs and in catalog source links: do not include the "v" prefix here
    ocp4-ver: "4.12"
    # for the project
    che-plugin-registry-directory: che-plugin-registry
    devworkspace-operator-index-disconnected-install: quay.io/devfile/devworkspace-operator-index:release-digest
    devworkspace-operator-version-patch: "0.27.0"
    devworkspace: DevWorkspace
    devworkspace-id: devworkspace
    docker-cli: docker
    hosted-che-docs: xref:hosted-che:hosted-che.adoc[]
    identity-provider-legacy-id: keycloak
    identity-provider-legacy: Keycloak
    image-puller-cr-name: KubernetesImagePuller
    image-puller-deployment-id: kubernetes-image-puller-operator
    image-puller-deployment-name: kubernetes-image-puller
    image-puller-image-name: quay.io/eclipse/kubernetes-image-puller
    image-puller-image-tag: latest
    image-puller-images: "java11-maven=quay.io/eclipse/che-java11-maven:nightly;che-theia=quay.io/eclipse/che-theia:next;java-plugin-runner=eclipse/che-remote-plugin-runner-java8:latest;"
    image-puller-name-short: Image Puller
    image-puller-name: Kubernetes Image Puller
    image-puller-namespace: k8s-image-puller
    image-puller-operator-id: kubernetes-image-puller-operator
    image-puller-operator-name: Kubernetes Image Puller Operator
    image-puller-operator-repository-name: kubernetes-image-puller-operator
    image-puller-repository-name: kubernetes-image-puller
    kube-ver-min: "1.21"
    kubernetes: Kubernetes
    link-installing-orch-cli: "link:https://kubernetes.io/docs/tasks/tools/#kubectl[Kubernetes - Install Tools: kubectl]"
    link-kube-rbac-proxy: link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy]
    link-manage-compute-resources-container: "link:https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/[{kubernetes} - Resource management for pods and containers]"
    link-oauth2-proxy: link:https://github.com/oauth2-proxy/oauth2-proxy[OAuth2 Proxy]
    link-prod-cli-documentation: "link:https://github.com/che-incubator/chectl/[`chectl` reference documentation]"
    link-understanding-custom-resources: "link:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[Kubernetes - Understanding Custom Resources]"
    namespace: namespace # In context: API namespace
    orch-cli-link: link:https://kubernetes.io/docs/reference/kubectl/overview/[Overview of kubectl]
    orch-cli: kubectl
    orch-ingress: Kubernetes Ingress
    orch-name: Kubernetes
    orch-namespace: namespace # In context: orch-name orch-namespace
    osd: OpenShift Dedicated
    platforms-cli: "`kubectl` or `oc`"
    platforms-ingress: Kubernetes Ingress or OpenShift Route
    platforms-name: Kubernetes or OpenShift
    platforms-namespace: Kubernetes namespace or OpenShift project
    pre-migration-prod-checluster: eclipse-che
    pre-migration-prod-deployment: che
    pre-migration-prod-id-short: che
    pre-migration-prod-operator: che-operator
    pre-migration-prod-subscription: eclipse-che
    pre-migration-prod-package: eclipse-che
    pre-migration-prod-channel: stable
    pre-migration-prod-catalog-source: community-operators
    pre-migration-prod-starting-csv: eclipse-che.v7.41.2
    prod-checluster: eclipse-che
    prod-cli: chectl
    prod-deployment: che
    prod-docs-url-backup-recovery: link:https://www.eclipse.org/che/docs/che-7/administration-guide/backup-and-recovery/[Backup and recovery]
    prod-docs-url-enable-oauth: link:https://www.eclipse.org/che/docs/che-7/administration-guide/configuring-openshift-oauth/[Configuring OpenShift OAuth]
    prod-home: /home/user
    prod-host: che-host
    prod-id-short: che
    prod-id: eclipse-che
    prod-last-version-pre-dwo: 7.41
    prod-namespace: eclipse-che
    prod-operator-bundle-name: eclipse-che
    prod-operator-image-name: che-operator
    prod-operator-index: registry.access.redhat.com/redhat/community-operator-index:v{ocp4-ver}
    prod-operator-package-name: eclipse-che
    prod-operator: che-operator
    prod-prev-short: Che
    prod-prev-id-short: che
    prod-prev-ver: "previous minor version"
    prod-short: Che
    prod-stable-channel-catalog-source: community-operators
    prod-stable-channel-package: eclipse-che
    prod-stable-channel: stable
    prod-stable-channel-starting-csv: eclipse-che.v7.49.0
    prod-upstream: Eclipse Che
    prod-url: "https://__<che_fqdn>__"
    prod-ver-major: "7"
    prod-ver-patch: "7.85.0"
    prod-ver: "7.85"
    prod-workspace: che-ws
    prod: Eclipse Che
    prod2: Eclipse Che
    project-context: che
    repo-path: ""
    rh-os-devspaces: Red Hat OpenShift Dev Spaces
    rh-os-local: Red Hat OpenShift Local
    theia-endpoint-image: eclipse/che-theia-endpoint-runtime:next
ext:
  collector:
  - run:
      command: ./tools/detect-unused-content.sh
  - run:
      command: ./tools/validate_language_changes.sh
  - run:
      command: ./tools/checluster_docs_gen.sh
    scan:
      base: modules/administration-guide/examples/checluster-properties
      dir: build/collector/checluster-properties
      files: checluster-properties.adoc
#   - run:
#       command: ./tools/environment_docs_gen.sh
#     scan:
#       base: modules/administration-guide/examples/che-server-properties
#       dir: build/collector/che-server-properties
#       files: system-variables.adoc
  - run:
      command: ./tools/create_architecture_diagrams.py
    scan:
      base: modules/administration-guide/images/architecture/
      dir: build/collector/architecture-diagrams
      files: '*.png'