Skip to content

Conversation

openshift-cherrypick-robot

This is an automated cherry-pick of #26255

/assign bobfuru

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).
@openshift-ci-robot openshift-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 8, 2020
@bobfuru bobfuru merged commit f251d92 into openshift:enterprise-4.6 Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants