Skip to content

TELCODOCS-2762: Apply DITA formatting and split downloading module for enterprise-4.20#115864

Merged
slovern merged 1 commit into
openshift:enterprise-4.20from
slovern:TELCODOCS-2762-dita-420
Jul 21, 2026
Merged

TELCODOCS-2762: Apply DITA formatting and split downloading module for enterprise-4.20#115864
slovern merged 1 commit into
openshift:enterprise-4.20from
slovern:TELCODOCS-2762-dita-420

Conversation

@slovern

@slovern slovern commented Jul 20, 2026 •
edited by openshift-ci Bot
Loading

Copy link
Copy Markdown
Contributor

This PR applies DITA compliance changes to the ZTP pre-caching tool documentation for enterprise-4.20:

Changes

  • Add [role="_abstract"] to all modules and assembly
  • Convert callout blocks (<1>, <2>, etc.) to "Where:" definition lists
  • Convert .Example output block titles to inline text
  • Fix .Procedure/[NOTE] rendering issue in booting-from-live-os module
  • Split monolithic ztp-precaching-downloading-artifacts.adoc into:
    • ztp-precaching-downloading-overview.adoc (CONCEPT)
    • ztp-precaching-preparing-ocp-images.adoc (PROCEDURE)
    • ztp-precaching-downloading-ocp-images.adoc (PROCEDURE)
    • ztp-precaching-downloading-operator-images.adoc (PROCEDURE)
    • ztp-precaching-custom-disconnected.adoc (PROCEDURE)

Relationship to main

This PR incorporates all DITA-related changes from:

These changes were adapted to the enterprise-4.20 branch content structure (which uses SiteConfig rather than ClusterInstance).

/label TELCODOCS-2762

Made with Cursor

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 20, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 20, 2026 •
edited by openshift-ci Bot
Loading

Copy link
Copy Markdown

@slovern: This pull request references TELCODOCS-2762 which is a valid jira issue.

Details

In response to this:

This PR applies DITA compliance changes to the ZTP pre-caching tool documentation for enterprise-4.20:

Changes

  • Add [role="_abstract"] to all modules and assembly
  • Convert callout blocks (<1>, <2>, etc.) to "Where:" definition lists
  • Convert .Example output block titles to inline text
  • Fix .Procedure/[NOTE] rendering issue in booting-from-live-os module
  • Split monolithic ztp-precaching-downloading-artifacts.adoc into:
  • ztp-precaching-downloading-overview.adoc (CONCEPT)
  • ztp-precaching-preparing-ocp-images.adoc (PROCEDURE)
  • ztp-precaching-downloading-ocp-images.adoc (PROCEDURE)
  • ztp-precaching-downloading-operator-images.adoc (PROCEDURE)
  • ztp-precaching-custom-disconnected.adoc (PROCEDURE)

Relationship to main

This PR incorporates all DITA-related changes from:

These changes were adapted to the enterprise-4.20 branch content structure (which uses SiteConfig rather than ClusterInstance).

/label TELCODOCS-2762

Made with Cursor

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci

openshift-ci Bot commented Jul 20, 2026 •
edited
Loading

Copy link
Copy Markdown

@slovern: The label(s) /label [TELCODOCS-2762](https://redhat.atlassian.net/browse/TELCODOCS-2762) cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, ux-approved, no-qe, rebase/manual, cluster-config-api-changed, run-integration-tests, verified, ready-for-human-review, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, cloud-experts, cnv, dev-tools, distributed-tracing, ims, jira/skip-dependent-bug-check, jira/valid-bug, merge-review-in-progress, merge-review-needed, mtc, multi-arch, oadp, ok-to-test, rhacs, rhv, sd-docs, serverless, service-mesh, sme-review-done, sme-review-needed, stability-fix-approved, staff-eng-approved, telco. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

Details

In response to this:

This PR applies DITA compliance changes to the ZTP pre-caching tool documentation for enterprise-4.20:

Changes

  • Add [role="_abstract"] to all modules and assembly
  • Convert callout blocks (<1>, <2>, etc.) to "Where:" definition lists
  • Convert .Example output block titles to inline text
  • Fix .Procedure/[NOTE] rendering issue in booting-from-live-os module
  • Split monolithic ztp-precaching-downloading-artifacts.adoc into:
  • ztp-precaching-downloading-overview.adoc (CONCEPT)
  • ztp-precaching-preparing-ocp-images.adoc (PROCEDURE)
  • ztp-precaching-downloading-ocp-images.adoc (PROCEDURE)
  • ztp-precaching-downloading-operator-images.adoc (PROCEDURE)
  • ztp-precaching-custom-disconnected.adoc (PROCEDURE)

Relationship to main

This PR incorporates all DITA-related changes from:

These changes were adapted to the enterprise-4.20 branch content structure (which uses SiteConfig rather than ClusterInstance).

/label TELCODOCS-2762

Made with Cursor

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-ci openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 20, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 20, 2026 •
edited
Loading

Copy link
Copy Markdown

🤖 Tue Jul 21 09:23:06 - Prow CI generated the docs preview:

https://115864--ocpdocs-pr.netlify.app/
https://115864--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-precaching-tool.html

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Jul 20, 2026
View reviewed changes
Comment thread modules/ztp-precaching-preparing-ocp-images.adoc
+
`/root/.docker/config.json` is the default path where `podman` checks for the login credentials for the registry.

[NOTE]

@ocpdocs-vale-bot ocpdocs-vale-bot Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskStep: Content other than a single list cannot be mapped to DITA steps.

@slovern
slovern force-pushed the TELCODOCS-2762-dita-420 branch from a9f5a5c to 2bee8c7 Compare July 20, 2026 17:15
Shane Lovern @cursoragent
TELCODOCS-2762: Apply DITA formatting and split downloading module fo…
ce1cd1d 
…r enterprise-4.20

This PR applies DITA compliance changes to the ZTP pre-caching tool documentation:

- Add [role="_abstract"] to all modules and assembly
- Convert callout blocks (<1>, <2>, etc.) to "Where:" definition lists
- Convert .Example output block titles to inline text
- Fix .Procedure/.Note rendering issue in booting-from-live-os module
- Split monolithic ztp-precaching-downloading-artifacts.adoc into:
  - ztp-precaching-downloading-overview.adoc (CONCEPT)
  - ztp-precaching-preparing-ocp-images.adoc (PROCEDURE)
  - ztp-precaching-downloading-ocp-images.adoc (PROCEDURE)
  - ztp-precaching-downloading-operator-images.adoc (PROCEDURE)
  - ztp-precaching-custom-disconnected.adoc (PROCEDURE)

This aligns with changes merged in main PRs openshift#106776 and openshift#115675.

Co-authored-by: Cursor <cursoragent@cursor.com>
@slovern
slovern force-pushed the TELCODOCS-2762-dita-420 branch from 2bee8c7 to ce1cd1d Compare July 21, 2026 09:12
@openshift-ci

openshift-ci Bot commented Jul 21, 2026

Copy link
Copy Markdown

@slovern: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@slovern slovern added this to the Continuous Release milestone Jul 21, 2026
@slovern
slovern merged commit d12510a into openshift:enterprise-4.20 Jul 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

branch/enterprise-4.20 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Milestone

Continuous Release

Development

Successfully merging this pull request may close these issues.

4 participants

@slovern @openshift-ci-robot @ocpdocs-previewbot @ocpdocs-vale-bot