Skip to content

DOCPLAN-400: Convert ifeval to ifdef for DITA compatibility #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danielclowers wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOCPLAN-400: Convert ifeval to ifdef for DITA compatibility #952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions documentation/modules/common-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
// doc metadata
:icons: font
:build: downstream
:downstream:

@coderabbitai coderabbitai Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Scope :downstream: to downstream-only builds.

Defining :downstream: in the shared attributes file makes it true for upstream renders as well, because both master docs include this file unconditionally. That will cause the new ifdef::downstream[] blocks in the install/upgrade procedures to render alongside the upstream content instead of staying mutually exclusive.

♻️ Suggested fix 
-:downstream:

Set the attribute from a downstream-only include or build arg instead.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
:downstream:
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@documentation/modules/common-attributes.adoc` at line 48, The shared
attribute definition is making downstream-only content render in upstream builds
as well. Remove the unconditional :downstream: setting from common-attributes
and set it only from a downstream-specific include or build argument; this keeps
the ifdef::downstream[] sections in the install and upgrade docs mutually
exclusive. Use the downstream attribute handling around common-attributes and
the install/upgrade procedure docs as the key places to adjust.

:toc: macro
:experimental:
:keywords: migration, VMware, OpenShift Virtualization, KubeVirt, migrating, virtual machines, OpenShift, Red Hat Virtualization, RHV
Expand Down
6 changes: 3 additions & 3 deletions documentation/modules/proc_installing-mtv-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ endif::[]
ifdef::web[]
. In the {ocp} web console, click *Operators* -> *OperatorHub*.
. Use the *Filter by keyword* field to search for *{operator}*.
ifeval::["{build}" == "upstream"]
ifdef::upstream[]
+
[NOTE]
====
Expand Down Expand Up @@ -76,7 +76,7 @@ EOF
----

. Create a `Subscription` CR for the Operator:
ifeval::["{build}" == "upstream"]
ifdef::upstream[]
+
[source,terminal,subs="attributes+"]
----
Expand All @@ -96,7 +96,7 @@ spec:
EOF
----
endif::[]
ifeval::["{build}" == "downstream"]
ifdef::downstream[]
+
[source,terminal,subs="attributes+"]
----
Expand Down
8 changes: 4 additions & 4 deletions documentation/modules/proc_upgrading-mtv-ui.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ You can upgrade the {operator-name} by using the {ocp} web console to install th

. Change the update channel to the correct release.
+
ifeval::["{build}" == "upstream"]
ifdef::upstream[]
See link:https://docs.okd.io/latest/operators/admin/olm-upgrading-operators.html#olm-changing-update-channel_olm-upgrading-operators[Changing update channel] in the {ocp} documentation.
endif::[]
ifeval::["{build}" == "downstream"]
ifdef::downstream[]
See {ocp-doc}/operators/administrator-tasks#olm-changing-update-channel_olm-upgrading-operators[Changing the update channel for an Operator] in the {ocp} documentation.
endif::[]

Expand All @@ -44,10 +44,10 @@ If you set *Update approval* on the *Subscriptions* tab to *Automatic*, the upgr
+
. If you set *Update approval* on the *Subscriptions* tab to *Manual*, approve the upgrade.
+
ifeval::["{build}" == "upstream"]
ifdef::upstream[]
See link:https://docs.okd.io/latest/operators/admin/olm-upgrading-operators.html#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending upgrade] in the {ocp} documentation.
endif::[]
ifeval::["{build}" == "downstream"]
ifdef::downstream[]
See {ocp-doc}/operators/administrator-tasks#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator upgrade] in the {ocp} documentation.
endif::[]

Expand Down
1 change: 1 addition & 0 deletions documentation/upstream-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@

// Build type
:build: upstream
:upstream:

// TOC configuration — produces a fixed left sidebar TOC
:toc: left
Expand Down
Loading