Merge branch 'main' into RHIDP-3835-Home-Page-Document-how-users-can-customize-the-Home-page

Author: jmagak

.asciidoctor/docs.css

@@ -220,7 +220,7 @@ table {
   border:0;
   font-size:1rem;
   line-height:1.6667;
-  table-layout:fixed
+  /* commented out as it breaks on Safari on Mac // table-layout:fixed */
 }
 table caption {
   color:#585858;

.github/workflows/build-asciidoc.yml

@@ -17,10 +17,11 @@ name: GitHub Pages
 
 on:
   push:
-    branches: 
+    branches:
     - main
     - rhdh-1.**
     - 1.**.x
+    - release-1.**
 
 jobs:
   adoc_build:
@@ -40,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
@@ -59,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 }}"
@@ -69,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/pr.yml

@@ -27,6 +27,7 @@ on:
     - main
     - rhdh-1.**
     - 1.**.x
+    - release-1.**
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.number || github.event.pull_request.head.ref }}
@@ -47,7 +48,7 @@ jobs:
           echo "✓"
 
   adoc_build:
-    name: Asciidoctor Build For PR branch preview
+    name: Ccutil Build For PR branch preview
     runs-on: ubuntu-latest
     needs: authorize
     permissions:
@@ -68,13 +69,13 @@ jobs:
           # update
           sudo apt-get update -y || true
           # install 
-          sudo apt-get -y -q install asciidoctor && asciidoctor --version
+          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 PR ${{ github.event.pull_request.number }}"
-          build/scripts/build.sh -b "pr-${{ github.event.number }}"
+          build/scripts/build-ccutil.sh -b "pr-${{ github.event.number }}"
 
       - name: Pull from origin before pushing (if possible)
         run: |
@@ -90,14 +91,19 @@ jobs:
           keep_files: true
           publish_dir: ./titles-generated
 
-      - name: PR comment with doc preview
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.RHDH_BOT_TOKEN }}
-          script: |
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: 'PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-${{ github.event.number }}/' 
-            });
+      - name: PR comment with doc preview, replacing existing comments with a new one each time
+        shell: bash
+        env:
+          GH_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
+        run: |
+          PR_NUM="${{ github.event.number }}"
+          ORG_REPO="${{ github.repository_owner }}/${{ github.event.repository.name }}"
+          gh repo set-default "${ORG_REPO}"
+          # for a given PR, check for existing comments from rhdh-bot; select the last one (if more than one)
+          if [[ $(gh api "repos/${ORG_REPO}/issues/${PR_NUM}/comments" -q 'map(select(.user.login=="rhdh-bot"))|last|.id') ]]; then 
+            # edit that comment:
+            gh pr comment ${PR_NUM} -R "${ORG_REPO}" --edit-last --body "Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-${PR_NUM}/ @ $(date "+%x %X")"
+          else
+            # or create a new one:
+            gh pr comment ${PR_NUM} -R "${ORG_REPO}" --body "Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-${PR_NUM}/"
+          fi

.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

archive/proc-customize-rhdh-branding.adoc

@@ -13,22 +13,26 @@
 :product-version: 1.3
 :product-bundle-version: 1.3.0
 :product-chart-version: 1.3.0
-:product-backstage-version: 1.27.7
+:product-backstage-version: 1.29.2
 :rhdeveloper-name: Red Hat Developer
 :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.17
 // 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
@@ -43,6 +47,8 @@
 :aks-short: AKS
 :gke-brand-name: Google Kubernetes Engine
 :gke-short: GKE
+:gcp-brand-name: Google Cloud Platform
+:gcp-short: GCP
 
 // Release Notes
 :rn-product-title: Release notes for Red Hat Developer Hub
@@ -67,3 +73,33 @@
 
 :LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index
 :NameOfPluginsGuide: Configuring plugins in {product}
+
+:release-notes-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/release_notes/index
+:release-notes-title: Release notes
+
+: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-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-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-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-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-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-single/configuring_dynamic_plugins/index
+:plugins-configure-book-title: Configuring dynamic plugins

artifacts/attributes.adoc

@@ -0,0 +1,78 @@
+= Enabling the Argo CD plugin
+
+You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflows in OpenShift GitOps. This plugin provides a visual overview of the application’s status, deployment details, commit message, author of the commit, container image promoted to environment and deployment history.
+
+.Prerequisites
+
+* Add Argo CD instance information to your `app-config.yaml` configmap as shown in the following example:
+
++
+[source,yaml]
+----
+argocd:
+  appLocatorMethods:
+    - type: 'config'
+      instances:
+        - name: argoInstance1
+          url: https://argoInstance1.com
+          username: ${ARGOCD_USERNAME}
+          password: ${ARGOCD_PASSWORD}
+        - name: argoInstance2
+          url: https://argoInstance2.com
+          username: ${ARGOCD_USERNAME}
+          password: ${ARGOCD_PASSWORD}
+----
+
+* Add the following annotation to the entity’s `catalog-info.yaml` file to identify the Argo CD applications.
+
++
+[source,yaml]
+----
+annotations:
+  ...
+  # The label that Argo CD uses to fetch all the applications. The format to be used is label.key=label.value. For example, rht-gitops.com/janus-argocd=quarkus-app.
+
+  argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}' 
+----
+
+* (Optional) Add the following annotation to the entity’s `catalog-info.yaml` file to switch between Argo CD instances as shown in the following example:
+
++
+[source,yaml]
+----
+ annotations:
+   ...
+    # The Argo CD instance name used in `app-config.yaml`.
+
+    argocd/instance-name: '${ARGOCD_INSTANCE}' 
+----
+
++
+[NOTE]
+====
+If you do not set this annotation, the Argo CD plugin defaults to the first Argo CD instance configured in `app-config.yaml`.
+====
+
+.Procedure
+
+. Add the following to your dynamic-plugins ConfigMap to enable the Argo CD plugin.
++
+[source,yaml]
+----
+global:
+  dynamic:
+    includes:
+      - dynamic-plugins.default.yaml
+    plugins:
+      - package: ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic
+        disabled: false
+      - package: ./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd
+        disabled: false
+----
+
+[role="_additional-resources"]
+.Additional resources
+
+* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{rn-product-title}_. 
+
+* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].