Merge branch 'main' into RHIDP-4345

Author: themr0c

.github/workflows/build-asciidoc.yml

@@ -17,7 +17,7 @@ name: GitHub Pages
 
 on:
   push:
-    branches: 
+    branches:
     - main
     - rhdh-1.**
     - 1.**.x
@@ -41,14 +41,14 @@ jobs:
       run: |
         # update
         sudo apt-get update -y || true
-        # install 
-        sudo apt-get -y -q install asciidoctor && asciidoctor --version
+        # install
+        sudo apt-get -y -q install podman && podman --version
         echo "GIT_BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_ENV
 
     - name: Build guides and indexes
       run: |
         echo "Building branch ${{ env.GIT_BRANCH }}"
-        build/scripts/build.sh -b ${{ env.GIT_BRANCH }}
+        build/scripts/build-ccutil.sh -b ${{ env.GIT_BRANCH }}
 
     # repo must be public for this to work
     - name: Deploy
@@ -60,7 +60,7 @@ jobs:
         keep_files: true
         publish_dir: ./titles-generated
 
-    - name: Cleanup merged PR branches 
+    - name: Cleanup merged PR branches
       run: |
         PULL_URL="https://api.github.com/repos/redhat-developer/red-hat-developers-documentation-rhdh/pulls"
         GITHUB_TOKEN="${{ secrets.RHDH_BOT_TOKEN }}"
@@ -70,7 +70,7 @@ jobs:
         git checkout gh-pages; git pull || true
         dirs=$(find . -maxdepth 1 -name "pr-*" -type d | sed -r -e "s|^\./pr-||")
         refs=$(cat pulls.html | grep pr- | sed -r -e "s|.+.html>pr-([0-9]+)</a>.+|\1|")
-        for d in $(echo -e "$dirs\n$refs" | sort -uV); do 
+        for d in $(echo -e "$dirs\n$refs" | sort -uV); do
           PR="${d}"
           echo -n "Check merge status of PR $PR ... "
           PR_JSON=$(curl -sSL -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $GITHUB_TOKEN" "$PULL_URL/$PR")

.github/workflows/style-guide.yml

@@ -0,0 +1,22 @@
+---
+name: Verify style guide compliance on pull request
+on: [pull_request]
+
+jobs:
+  vale:
+    name: Linting with Vale
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Asciidoctor
+        run: sudo apt-get install -y asciidoctor
+      - name: Run Vale on new and modified content
+        uses: errata-ai/[email protected]
+        with:
+          files: assemblies
+          vale_flags: "--minAlertLevel=warning"
+          reporter: github-pr-review
+        env:
+          GITHUB_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}

.gitignore

@@ -2,7 +2,6 @@
 titles/*/build
 index.html
 titles-generated/
-.vale.ini
 .vale-styles/RedHat
 .vscode
 .cache/

.vale-styles/DeveloperHub/tests/.vale.ini

@@ -0,0 +1,12 @@
+; .vale.ini
+; Specifies Vale configuration
+; See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/
+;
+; Download and search Vale styles in this directory:
+StylesPath = ../..
+; Minimum alert level to display:
+MinAlertLevel = suggestion
+; Display alerts on AsciiDoc files:
+[*.adoc]
+; Apply these styles:
+BasedOnStyles = DeveloperHub

.vale.ini

@@ -0,0 +1,18 @@
+# .vale.ini
+# Specifies Vale configuration
+# See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/
+#
+
+# Download and search Vale styles in this directory:
+StylesPath = ".vale-styles"
+
+# Minimum alert level to display:
+MinAlertLevel = suggestion
+
+# Styles to download:
+Packages = RedHat
+
+# Display alerts on AsciiDoc files:
+[*.adoc]
+# Apply these styles:
+BasedOnStyles = RedHat,DeveloperHub

artifacts/attributes.adoc

@@ -18,17 +18,21 @@
 :rhel: Red Hat Enterprise Linux
 :odf-name: OpenShift Data Foundation
 
+:my-product-url: https://__<my_developer_hub_url>__
+
 // Red Hat Platforms
 :ocp-brand-name: Red Hat OpenShift Container Platform
 :ocp-short: OpenShift Container Platform
 :ocp-very-short: RHOCP
 :osd-brand-name: Red Hat OpenShift Dedicated
 :osd-short: OpenShift Dedicated
 // minimum and current latest supported versions
-:ocp-version-min: 4.12
-:ocp-version: 4.15
+:ocp-version-min: 4.14
+:ocp-version: 4.16
 // First mention of OpenShift CLI or `oc` in a module
 :openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
+:rhsso-brand-name: Red Hat Single-Sign On
+:rhsso: RHSSO
 
 // Partner Platforms
 :aws-brand-name: Amazon Web Services
@@ -76,27 +80,26 @@
 :installing-and-viewing-dynamic-plugins-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_dynamic_plugins/index
 :installing-and-viewing-dynamic-plugins-title: Installing and viewing dynamic plugins
 
-
 :authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication/index
 :authentication-book-title: Authentication
 
 :authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
 :authorization-book-title: Authorization
 
-:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_openshift_container_platform/index
+:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
 :installing-on-ocp-book-title: Installing {product} on {ocp-short}
 
-:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
+:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
 :installing-on-eks-book-title: Installing {product} on {eks-brand-name}
 
-:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
+:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
 :installing-on-aks-book-title: Installing {product} on {aks-brand-name}
 
-:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
+:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
 :installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
 
-:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/upgrading_red_hat_developer_hub/index
+:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
 :upgrading-book-title: Upgrading {product}
 
-:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/configuring_dynamic_plugins/index
+:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
 :plugins-configure-book-title: Configuring dynamic plugins

artifacts/snip-customer-support-info.adoc

@@ -5,4 +5,4 @@
 If you experience difficulty with a procedure described in this documentation, visit the http://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes:
 
 * To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products. 
-* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for Red Hat Global Support Services (GSS). For support case creation, select *Red Hat Developer Hub* as the product and select the appropriate product version.
+* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. For detailed information about supported platforms, see link:{release-notes-url}#con-release-notes-overview.adoc[Supported Platforms] and the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].

artifacts/snip-technology-preview.adoc

@@ -0,0 +1,6 @@
+[IMPORTANT]
+====
+These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
+
+For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
+====

assemblies/assembly-add-custom-app-file-openshift.adoc

@@ -3,7 +3,7 @@
 
 To access the {product}, you must add a custom application configuration file to {ocp-brand-name}. In {ocp-short}, you can use the following content as a base template to create a ConfigMap named `app-config-rhdh`:
 
-[source,yaml]
+[source,yaml,subs="attributes+"]
 ----
 kind: ConfigMap
 apiVersion: v1
@@ -18,7 +18,7 @@ data:
 You can add the custom application configuration file to {ocp-short} in one of the following ways:
 
 * The {product} Operator
-* The {product} Helm chart.
+* The {product} Helm chart
 
 include::modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc[leveloffset=+1]
 

assemblies/assembly-admin-templates.adoc

@@ -22,5 +22,4 @@ include::modules/templates/proc-adding-templates.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* link:{LinkGettingStartedGuide}[Configuring a GitHub App in {product-short}]
-* link:{LinkGettingStartedGuide}[Enabling the GitLab OAuth authentication provider]
+* link:{authentication-book-url}#assembly-auth-provider-github[Enabling the GitHub authentication provider]