Skip to content

Commit 99c8fc5

Browse files
authored
Merge branch 'main' into RHIDP-4362
2 parents 1c0be68 + 8e6a217 commit 99c8fc5

File tree

83 files changed

+989
-746
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+989
-746
lines changed

.github/workflows/build-asciidoc.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ name: GitHub Pages
1717

1818
on:
1919
push:
20-
branches:
20+
branches:
2121
- main
2222
- rhdh-1.**
2323
- 1.**.x
@@ -41,14 +41,14 @@ jobs:
4141
run: |
4242
# update
4343
sudo apt-get update -y || true
44-
# install
45-
sudo apt-get -y -q install asciidoctor && asciidoctor --version
44+
# install
45+
sudo apt-get -y -q install podman && podman --version
4646
echo "GIT_BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_ENV
4747
4848
- name: Build guides and indexes
4949
run: |
5050
echo "Building branch ${{ env.GIT_BRANCH }}"
51-
build/scripts/build.sh -b ${{ env.GIT_BRANCH }}
51+
build/scripts/build-ccutil.sh -b ${{ env.GIT_BRANCH }}
5252
5353
# repo must be public for this to work
5454
- name: Deploy
@@ -60,7 +60,7 @@ jobs:
6060
keep_files: true
6161
publish_dir: ./titles-generated
6262

63-
- name: Cleanup merged PR branches
63+
- name: Cleanup merged PR branches
6464
run: |
6565
PULL_URL="https://api.github.com/repos/redhat-developer/red-hat-developers-documentation-rhdh/pulls"
6666
GITHUB_TOKEN="${{ secrets.RHDH_BOT_TOKEN }}"
@@ -70,7 +70,7 @@ jobs:
7070
git checkout gh-pages; git pull || true
7171
dirs=$(find . -maxdepth 1 -name "pr-*" -type d | sed -r -e "s|^\./pr-||")
7272
refs=$(cat pulls.html | grep pr- | sed -r -e "s|.+.html>pr-([0-9]+)</a>.+|\1|")
73-
for d in $(echo -e "$dirs\n$refs" | sort -uV); do
73+
for d in $(echo -e "$dirs\n$refs" | sort -uV); do
7474
PR="${d}"
7575
echo -n "Check merge status of PR $PR ... "
7676
PR_JSON=$(curl -sSL -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $GITHUB_TOKEN" "$PULL_URL/$PR")

.github/workflows/pr.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
echo "✓"
4949
5050
adoc_build:
51-
name: Asciidoctor Build For PR branch preview
51+
name: Ccutil Build For PR branch preview
5252
runs-on: ubuntu-latest
5353
needs: authorize
5454
permissions:
@@ -69,13 +69,13 @@ jobs:
6969
# update
7070
sudo apt-get update -y || true
7171
# install
72-
sudo apt-get -y -q install asciidoctor && asciidoctor --version
72+
sudo apt-get -y -q install podman && podman --version
7373
echo "GIT_BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_ENV
7474
7575
- name: Build guides and indexes
7676
run: |
7777
echo "Building PR ${{ github.event.pull_request.number }}"
78-
build/scripts/build.sh -b "pr-${{ github.event.number }}"
78+
build/scripts/build-ccutil.sh -b "pr-${{ github.event.number }}"
7979
8080
- name: Pull from origin before pushing (if possible)
8181
run: |

.github/workflows/style-guide.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Verify style guide compliance on pull request
3+
on: [pull_request]
4+
5+
jobs:
6+
vale:
7+
name: Linting with Vale
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v4
12+
- name: Install Asciidoctor
13+
run: sudo apt-get install -y asciidoctor
14+
- name: Run Vale on new and modified content
15+
uses: errata-ai/[email protected]
16+
with:
17+
files: assemblies
18+
vale_flags: "--minAlertLevel=warning"
19+
reporter: github-pr-review
20+
env:
21+
GITHUB_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
22+
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
titles/*/build
33
index.html
44
titles-generated/
5-
.vale.ini
65
.vale-styles/RedHat
76
.vscode
87
.cache/
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
; .vale.ini
2+
; Specifies Vale configuration
3+
; See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/
4+
;
5+
; Download and search Vale styles in this directory:
6+
StylesPath = ../..
7+
; Minimum alert level to display:
8+
MinAlertLevel = suggestion
9+
; Display alerts on AsciiDoc files:
10+
[*.adoc]
11+
; Apply these styles:
12+
BasedOnStyles = DeveloperHub

.vale.ini

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# .vale.ini
2+
# Specifies Vale configuration
3+
# See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/
4+
#
5+
6+
# Download and search Vale styles in this directory:
7+
StylesPath = ".vale-styles"
8+
9+
# Minimum alert level to display:
10+
MinAlertLevel = suggestion
11+
12+
# Styles to download:
13+
Packages = RedHat
14+
15+
# Display alerts on AsciiDoc files:
16+
[*.adoc]
17+
# Apply these styles:
18+
BasedOnStyles = RedHat,DeveloperHub

artifacts/attributes.adoc

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,12 @@
2727
:osd-brand-name: Red Hat OpenShift Dedicated
2828
:osd-short: OpenShift Dedicated
2929
// minimum and current latest supported versions
30-
:ocp-version-min: 4.12
31-
:ocp-version: 4.15
30+
:ocp-version-min: 4.14
31+
:ocp-version: 4.17
3232
// First mention of OpenShift CLI or `oc` in a module
3333
:openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
34+
:rhsso-brand-name: Red Hat Single-Sign On
35+
:rhsso: RHSSO
3436

3537
// Partner Platforms
3638
:aws-brand-name: Amazon Web Services
@@ -84,20 +86,20 @@
8486
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
8587
:authorization-book-title: Authorization
8688

87-
: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
89+
: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
8890
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
8991

90-
: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
92+
: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
9193
:installing-on-eks-book-title: Installing {product} on {eks-brand-name}
9294

93-
: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
95+
: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
9496
:installing-on-aks-book-title: Installing {product} on {aks-brand-name}
9597

96-
: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
98+
: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
9799
:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
98100

99-
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/upgrading_red_hat_developer_hub/index
101+
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
100102
:upgrading-book-title: Upgrading {product}
101103

102-
:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/configuring_dynamic_plugins/index
103-
:plugins-configure-book-title: Configuring dynamic plugins
104+
:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
105+
:plugins-configure-book-title: Configuring dynamic plugins

artifacts/snip-customer-support-info.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
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:
66

77
* To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products.
8-
* 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.
8+
* 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].
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[IMPORTANT]
2+
====
3+
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.
4+
5+
For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
6+
====

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ data:
1818
You can add the custom application configuration file to {ocp-short} in one of the following ways:
1919

2020
* The {product} Operator
21-
* The {product} Helm chart.
21+
* The {product} Helm chart
2222

2323
include::modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc[leveloffset=+1]
2424

0 commit comments

Comments
 (0)