Skip to content

ci-test-dec25: testing ci for asciidocditarules #104076

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
ShaunaDiaz wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ci-test-dec25: testing ci for asciidocditarules #104076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb99136
ci-test-dec25: testing ci for asciidocditarules
ShaunaDiaz Dec 17, 2025
807a56a
test shortdescription again
ShaunaDiaz Dec 17, 2025
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
11 changes: 6 additions & 5 deletions disconnected/about-installing-oc-mirror-v2.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ include::_attributes/common-attributes.adoc[]
:context: about-installing-oc-mirror-v2

toc::[]

You can run your cluster in a disconnected environment if you install the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running whenever your cluster is running.
//should hit shortdescription
You can run your cluster in a disconnected environment if you install the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running when your cluster is running.

You can use oc-mirror plugin v2 to mirror images to a mirror registry in your fully or partially disconnected environments. To download the required images from the official Red{nbsp}Hat registries, you must run oc-mirror plugin v2 from a system with internet connectivity.

Expand All @@ -17,8 +17,8 @@ include::modules/oc-mirror-v2-about.adoc[leveloffset=+1]
include::modules/oc-mirror-v2-support.adoc[leveloffset=+2]

[id="prerequisites_oc-mirror-v2_{context}"]
== Prerequisites

== Prerequisites for oc mirror v2
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.AssemblyContents: Content other than additional resources cannot follow include directives.

//should hit assemblycontents
* You must have a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker V2-2] in the location that hosts the {product-title} cluster, such as {quay}.
+
[NOTE]
Expand Down Expand Up @@ -84,7 +84,8 @@ include::modules/oc-mirror-restricted-fields.adoc[leveloffset=+2]
// Configuring your cluster to use the resources generated by oc-mirror
include::modules/oc-mirror-updating-cluster-manifests-v2.adoc[leveloffset=+2]

After your cluster is configured to use the resources generated by oc-mirror plugin v2, see xref:../disconnected/about-installing-oc-mirror-v2.adoc#next-steps_about-installing-oc-mirror-v2[Next steps] for information about tasks that you can perform using your mirrored images.
After your cluster is configured to use the oc-mirror plugin v2 generated resources, see xref:../disconnected/about-installing-oc-mirror-v2.adoc#next-steps_about-installing-oc-mirror-v2[Next steps] for information about tasks that you can perform using your mirrored images.
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

//should hit relatedlinks

[role="_additional-resources"]
.Additional resources
Expand Down
27 changes: 14 additions & 13 deletions disconnected/installing-mirroring-disconnected.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ include::_attributes/common-attributes.adoc[]

toc::[]

Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times as long as the cluster is running. See the xref:../disconnected/installing-mirroring-disconnected.adoc#prerequisites_installing-mirroring-disconnected[Prerequisites] section for more information.
Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times when the cluster is running. See the xref:../disconnected/installing-mirroring-disconnected.adoc#prerequisites_installing-mirroring-disconnected[Prerequisites] section for more information.
//should hit shortdescription

You can use the oc-mirror OpenShift CLI (`oc`) plugin to mirror images to a mirror registry in your fully or partially disconnected environments. You must run oc-mirror from a system with internet connectivity in order to download the required images from the official Red Hat registries.

Expand All @@ -23,20 +24,20 @@ include::modules/oc-mirror-support.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* For information on updating oc-mirror, see xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source].
//relatedlinks
* For information on updating oc-mirror, see the xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source].
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.


// About the mirror registry
include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source].
//relatedlinks
* xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing image pull source].
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.


[id="prerequisites_installing-mirroring-disconnected"]
== Prerequisites

== Prerequisite
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.AssemblyContents: Content other than additional resources cannot follow include directives.

//assemblycontents
* You must have a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2] in the location that will host the {product-title} cluster, such as {quay}.
+
[NOTE]
Expand Down Expand Up @@ -80,16 +81,16 @@ You can use the oc-mirror CLI plugin to mirror images to a mirror registry in a
These procedures assume that you already have your mirror registry set up.

[id="mirroring-image-set-partial"]
=== Mirroring an image set in a partially disconnected environment

=== Mirroring an image set in a partially disconnected environments
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections are not supported in DITA.

//nestedsection
In a partially disconnected environment, you can mirror an image set directly to the target mirror registry.

// Mirroring from mirror to mirror
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+3]

[id="mirroring-image-set-full"]
=== Mirroring an image set in a fully disconnected environment

=== Mirroring image sets in a fully disconnected environment
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections are not supported in DITA.

//nestedsection
To mirror an image set in a fully disconnected environment, you must first xref:../disconnected/installing-mirroring-disconnected.adoc#oc-mirror-mirror-to-disk_installing-mirroring-disconnected[mirror the image set to disk], then xref:../disconnected/installing-mirroring-disconnected.adoc#oc-mirror-disk-to-mirror_installing-mirroring-disconnected[mirror the image set file on disk to a mirror].

// Mirroring from mirror to disk
Expand All @@ -103,8 +104,8 @@ include::modules/oc-mirror-updating-cluster-manifests.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../extensions/catalogs/managing-catalogs.adoc#olmv1-adding-a-catalog-to-a-cluster_managing-catalogs[Adding a catalog to a cluster] in "Extensions"
//relatedlinks
* xref:../extensions/catalogs/managing-catalogs.adoc#olmv1-adding-a-catalog-to-a-cluster_managing-catalogs[Adding a catalog to cluster] in "Extensions"
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 17, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.


// About updating your mirror registry content
include::modules/oc-mirror-updating-registry-about.adoc[leveloffset=+1]
Expand Down