-
Notifications
You must be signed in to change notification settings - Fork 1.8k
modules/dynamic-provisioning-available-plugins: Drop xref #26255
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.
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
Conversation
xrefs aren't allowed in modules: $ grep -A1 'You must not include xrefs' modules/mod-docs-ocp-conventions.adoc You must not include xrefs in modules or create an xref to a module. You can only use xrefs to link from one assembly to another. And we can't move this module out into an assembly directory, because it is consumed from two places: $ git --no-pager grep dynamic-provisioning-available-plugins post_installation_configuration/storage-configuration.adoc:include::modules/dynamic-provisioning-available-plugins.adoc[leveloffset=+3] storage/dynamic-provisioning.adoc:include::modules/dynamic-provisioning-available-plugins.adoc[leveloffset=+1] We could: a. Trim down post_installation_configuration to just xref the storage assembly, instead of duping so much of it's content via modules. b. Drop the module and instead inline (some of) it with copy/paste in both assemblies. c. Remove the xref. With this commit, I'm going with (c), removing the xref which was added in 57961f1 ([STOR] Include section on the OpenStack Manila CSI Driver, 2020-05-12, openshift#22199).
There's a similar entry in: $ git --no-pager grep xref modules/dynamic-provisioning-manila-csi-definition.adoc
modules/dynamic-provisioning-manila-csi-definition.adoc:Once installed, the xref:../storage/container_storage_interface/persistent-storage-csi-manila.adoc#persistent-storage-csi-manila[OpenStack Manila CSI Driver Operator] and ManilaDriver automatically create the required storage classes for all available Manila share types needed for dynamic provisioning. But it is not used by $ git --no-pager grep dynamic-provisioning-manila-csi-definition
storage/dynamic-provisioning.adoc:include::modules/dynamic-provisioning-manila-csi-definition.adoc[leveloffset=+2] Is that oversight from d. Move the module under Thoughts? |
Thanks, @wking, for pointing this out. IIRC, the Good catch on the xref. I agree that it should be removed, so your proposed edit LGTM. Let me know if you'd like this PR merged, not sure if that option shows up for you in this repo? Thanks! |
I can't merge in this repo, and even if I could, I'd rather not merge my own stuff ;). If this looks good to docs maintainers, they can merge when they're ready. I'll circle back to the |
SGTM and LGTM, thanks again! |
/cherrypick enterprise-4.5 |
/cherrypick enterprise-4.6 |
@bobfuru: new pull request created: #26273 In response to this:
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/test-infra repository. |
@bobfuru: new pull request created: #26274 In response to this:
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/test-infra repository. |
xrefs aren't allowed in modules:
And we can't move this module out into an assembly directory, because it is consumed from two places:
We could:
a. Trim down post_installation_configuration to just xref the storage assembly, instead of duping so much of it's content via modules.
b. Drop the module and instead inline (some of) it with copy/paste in both assemblies.
c. Remove the xref.
With this commit, I'm going with (c), removing the xref which was added in 57961f1 (#22199). CC @bobfuru