Skip to content

[WIP] [POC] OSDOCS#17637: Updating the storage index.adoc navigation file#108999

Open
bergerhoffer wants to merge 1 commit intoopenshift:mainfrom
bergerhoffer:OSDOCS-17637-storage
Open

[WIP] [POC] OSDOCS#17637: Updating the storage index.adoc navigation file#108999
bergerhoffer wants to merge 1 commit intoopenshift:mainfrom
bergerhoffer:OSDOCS-17637-storage

Conversation

@bergerhoffer
Copy link
Contributor

@bergerhoffer bergerhoffer commented Mar 25, 2026

Version(s):
4.16+

Issue:

Link to docs preview:

QE review:
N/A - CQA work, just moving text around, no new technical info

Additional information:

  • Since this is resolving an index.adoc navigation file, xrefs are allowed in the resulting reference modules. These reference modules must only ever be included in one location
  • Content was copied from the assembly to the modules without any changes other than the abstract lines.
  • Didn't update the existing openshift-storage-common-terms.adoc module that already existed in the assembly - need to check scope of this effort and see if I should (has 3 vale warnings)

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 25, 2026
modules/csi.adoc Outdated
[role="_abstract"]
CSI is an API specification for the management of container storage across different container orchestration (CO) systems. You can manage the storage volumes within the container native environments, without having specific knowledge of the underlying storage infrastructure. With the CSI, storage works uniformly across different container orchestration systems, regardless of the storage vendors you are using.

For more information about CSI, see xref:../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Using Container Storage Interface (CSI)].
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

[role="_abstract"]
Dynamic Provisioning allows you to create storage volumes on-demand, eliminating the need for cluster administrators to pre-provision storage.

For more information about dynamic provisioning, see xref:../storage/dynamic-provisioning.adoc#dynamic-provisioning[Dynamic provisioning].
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See description - these navigation reference files are an exception for now

[id="ephemeral-storage_{context}"]
== Ephemeral storage

Pods and containers are ephemeral or transient in nature and designed for stateless applications. Ephemeral storage allows administrators and developers to better manage the local storage for some of their operations. For more information about ephemeral storage overview, types, and management, see xref:../storage/understanding-ephemeral-storage.adoc#understanding-ephemeral-storage[Understanding ephemeral storage].
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

[id="persistent-storage_{context}"]
== Persistent storage

Stateful applications deployed in containers require persistent storage. {product-title} uses a pre-provisioned storage framework called persistent volumes (PV) to allow cluster administrators to provision persistent storage. The data inside these volumes can exist beyond the lifecycle of an individual pod. Developers can use persistent volume claims (PVCs) to request storage requirements. For more information about persistent storage overview, configuration, and lifecycle, see xref:../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage].
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

@bergerhoffer bergerhoffer changed the title OSDOCS#17637: Updating the storage index.adoc navigation file [WIP] [POC] OSDOCS#17637: Updating the storage index.adoc navigation file Mar 25, 2026
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 25, 2026
@bergerhoffer bergerhoffer force-pushed the OSDOCS-17637-storage branch from 53d9af3 to 1012906 Compare March 25, 2026 18:30
@openshift-ci
Copy link

openshift-ci bot commented Mar 25, 2026

@bergerhoffer: 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants