Merge branch 'master' into future-architecture

.github/workflows/build-and-validate-on-pr.yaml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Build using antora # and fail on warning
         id: antora-build
-        run: CI=true antora generate antora-playbook.yml --stacktrace 2>&1 | (tee | grep  WARNING && exit 42 || exit 0)
+        run: CI=true antora generate antora-playbook-for-development.yml --stacktrace 2>&1 | (tee | grep  WARNING && exit 42 || exit 0)
 
       - name: Upload artifact doc-content
         uses: actions/upload-artifact@v2
@@ -68,7 +68,6 @@ jobs:
 
       - name: Validate language on files added or modified
         run: tools/validate_language_changes.sh
-      
+
       - name: Count Vale infringements
         run: tools/count_vale_errors.sh
-

.github/workflows/build-and-validate-on-push.yaml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Build using antora
         id: antora-build
-        run: CI=true antora generate antora-playbook.yml --stacktrace
+        run: CI=true antora generate antora-playbook-for-development.yml --stacktrace
 
       - name: Upload artifact
         uses: actions/upload-artifact@v2

.htmltest.yml

@@ -21,3 +21,4 @@ IgnoreURLs:
   - https://marketplace.visualstudio.com
   - https://github.com/eclipse/che-docs/edit/master/
   - https://www.eclipse.org/che/docs/che-7/
+  - https://projectlombok.org/

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
         name: Build documentation with Antora
         description: Build documentation with Antora
         language: docker_image
-        entry: docker.io/antora/antora antora-playbook.yml
+        entry: docker.io/antora/antora antora-playbook-for-development.yml
         pass_filenames: false
         always_run: true
         verbose: true

Jenkinsfile

@@ -18,10 +18,24 @@ spec:
       env:
       - name: "HOME"
         value: "/home/jenkins/agent"
+      resources:
+        limits:
+          memory: "512Mi"
+          cpu: "100m"
+        requests:
+          memory: "512Mi"
+          cpu: "100m"
     - name: che-docs
       image: quay.io/eclipse/che-docs
       command:
       - cat
+      resources:
+        limits:
+          memory: "512Mi"
+          cpu: "100m"
+        requests:
+          memory: "512Mi"
+          cpu: "100m"
       tty: true
   volumes:
   - configMap:
@@ -52,7 +66,11 @@ spec:
 
     stage('Checkout www repo (master)') {
       when {
-        branch 'master'
+          anyOf {
+            branch 'main';
+            branch 'master';
+            branch 'publication'
+          }
         beforeAgent true
       }
       steps {
@@ -76,9 +94,11 @@ spec:
         milestone 21
         container('che-docs') {
           dir('che-docs') {
-                sh './tools/environment_docs_gen.sh'
-                sh './tools/checluster_docs_gen.sh'
-                sh 'CI=true antora generate antora-playbook.yml --stacktrace'
+                sh '''
+                git config --add remote.origin.fetch +refs/heads/*:refs/remotes/origin/*
+                git fetch
+                ./tools/publication.sh
+                '''
             }
         }
         milestone 22
@@ -87,7 +107,11 @@ spec:
 
     stage('Push to www repo (master)') {
       when {
-        branch 'master'
+          anyOf {
+            branch 'main';
+            branch 'master';
+            branch 'publication'
+          }
         beforeAgent true
       }
       steps {

antora-playbook-for-development.yml

@@ -0,0 +1,28 @@
+---
+# Use this Antora Playbook for development, to build current state in HEAD.
+site:
+  title: Eclipse Che Documentation
+  # Disabling url on purpose to avoid htmltest crawling the live website.
+  # url: https://www.eclipse.org/che/docs
+  start_page: che-7:overview:introduction-to-eclipse-che.adoc
+  robots: allow
+content:
+  sources:
+    - url: ./
+      branches: HEAD
+      edit_url: "https://github.com/eclipse/che-docs/edit/master/{path}"
+output:
+  destinations:
+    - provider: fs
+      clean: true
+      path: build/site
+ui:
+  bundle:
+    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
+    snapshot: true
+  supplemental_files: ./supplemental-ui
+urls:
+  html_extension_style: indexify
+  redirect_facility: static
+runtime:
+  cache_dir: ./.cache/antora

antora-playbook-for-publication.yml

@@ -0,0 +1,30 @@
+---
+# Use this Antora Playbook for publication, to build the released version branch.
+site:
+  title: Eclipse Che Documentation
+  # The url property is mandatory to generate the 404 and sitemap files.
+  url: https://www.eclipse.org/che/docs
+  start_page: che-7:overview:introduction-to-eclipse-che.adoc
+  keys:
+    google_analytics: "UA-37306001-2"
+  robots: allow
+content:
+  sources:
+    - url: ./
+      branches: 7.35.x
+      edit_url: "https://github.com/eclipse/che-docs/edit/7.35.x/{path}"
+output:
+  destinations:
+    - provider: fs
+      clean: true
+      path: build/site
+ui:
+  bundle:
+    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
+    snapshot: true
+  supplemental_files: ./supplemental-ui
+urls:
+  html_extension_style: indexify
+  redirect_facility: static
+runtime:
+  cache_dir: ./.cache/antora

antora.yml

@@ -13,4 +13,96 @@ nav:
   - modules/contributor-guide/nav.adoc
   - modules/extensions/nav.adoc
   - modules/glossary/nav.adoc
-
+asciidoc:
+  attributes:
+    # for antora
+    context: che
+    experimental: ""
+    favicon: favicon.png
+    icons: font
+    # for the project
+    broker-ver: "v3.4.0"
+    che-devfile-registry-container-image: quay.io/eclipse/che-devfile-registry
+    che-devfile-registry-directory: che-devfile-registry
+    che-plugin-registry-container-image: quay.io/eclipse/che-plugin-registry
+    che-plugin-registry-directory: che-plugin-registry
+    devworkspace: Dev Workspace
+    identity-provider-docs-url: https://www.keycloak.org/docs/
+    identity-provider-id: keycloak
+    identity-provider-image-url: quay.io/eclipse/che-keycloak
+    identity-provider-url: https://www.keycloak.org/
+    identity-provider-version: "6.0"
+    identity-provider: 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.19"
+    kubernetes: Kubernetes
+    link-accessing-a-git-repository-via-https: xref:end-user-guide:version-control.adoc#accessing-a-git-repository-via-https_che[Accessing a Git repository using HTTPS]
+    link-advanced-configuration-options-for-the-che-server: xref:installation-guide:advanced-configuration-options-for-the-che-server-component.adoc[]
+    link-advanced-configuration-options: xref:installation-guide:advanced-configuration-options-for-the-che-server-component.adoc[]
+    link-building-a-custom-plug-in-registry: xref:administration-guide:building-and-running-a-custom-registry-image.adoc#building-a-custom-devfile-registry_che[Building a custom devfile registry]
+    link-cli-github: https://github.com/che-incubator/chectl
+    link-identity-provider-documentation-openshift-3: https://www.keycloak.org/docs/latest/server_admin/#openshift-3
+    link-identity-provider-documentation-openshift-4: https://www.keycloak.org/docs/latest/server_admin/#openshift-4
+    link-identity-provider-github: "https://www.keycloak.org/docs/6.0//server_admin/#github"
+    link-identity-provider-oidc: "https://www.keycloak.org/docs/6.0/server_admin/#_oidc"
+    link-identity-provider-saml: "https://www.keycloak.org/docs/6.0/server_admin/#saml-v2-0-identity-providers"
+    link-installing-an-instance: xref:installation-guide:installing-che.adoc[]
+    link-postgres-dockerfile-location: https://github.com/eclipse-che/che-server/tree/main/dockerfiles/postgres
+    link-server-identity-provider-dockerfile-location: https://github.com/eclipse-che/che-server/tree/main/dockerfiles/keycloak
+    link-viewing-the-state-of-the-cluster-deployment-using-openshift-4-cli-tools: xref:overview:installing-che-on-openshift-4-using-operatorhub.adoc[]
+    namespace: namespace # In context: API namespace
+    nodejs-stack: nodejs
+    ocp: OpenShift Container Platform
+    ocp3-ver: "3.11"
+    ocp4-ver: "4.6"
+    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-identity-provider: "Identity Provider (Keycloak or RH-SSO)"
+    platforms-ingress: Kubernetes Ingress or OpenShift Route
+    platforms-name: Kubernetes or OpenShift
+    platforms-namespace: Kubernetes namespace or OpenShift project
+    postgresql-image-url: quay.io/eclipse/che-postgres
+    prod-checluster: eclipse-che
+    prod-cli: chectl
+    prod-deployment: che
+    prod-docs-url: https://www.eclipse.org/che/docs
+    prod-home: /home/user
+    prod-host: che-host
+    prod-id-short: che
+    prod-id: eclipse-che
+    prod-namespace: eclipse-che
+    prod-operator-image-name: che-operator
+    prod-operator: che-operator
+    prod-prev-ver-major: "6"
+    prod-prev-ver: "7.34"
+    prod-short: Che
+    prod-upstream: Eclipse{nbsp}Che
+    prod-url: https://che-host:che-port
+    prod-ver-major: "7"
+    prod-ver-patch: "7.35.0"
+    prod-ver: "7.35"
+    prod-workspace: che-ws
+    prod: Eclipse Che
+    prod2: Eclipse Che
+    project-context: che
+    repo-path: ""
+    theia-endpoint-image: eclipse/che-theia-endpoint-runtime:next
+    url-devfile-registry-repo: https://github.com/eclipse/che-devfile-registry
+    url-plug-in-registry-repo: https://github.com/eclipse/che-plugin-registry

gulpfile.js

@@ -7,7 +7,7 @@ const { reload: livereload } = process.env.LIVERELOAD === 'true' ? require('gulp
 const { series, src, watch } = require('gulp')
 const yaml = require('js-yaml')
 
-const playbookFilename = 'antora-playbook.yml'
+const playbookFilename = 'antora-playbook-for-development.yml'
 const playbook = yaml.safeLoad(fs.readFileSync(playbookFilename, 'utf8'))
 const outputDir = (playbook.output || {}).dir || './build/site'
 const serverConfig = { name: 'Preview Site', livereload, host: '0.0.0.0', port: 4000, root: outputDir }