-
Notifications
You must be signed in to change notification settings - Fork 1.8k
WMCO remove [discrete] tags in prep for DITA migration #96757
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
|
@bergerhoffer Does this meet your expectations? |
|
/retest |
|
@mburke5678: all tests passed! Full PR test history. Your PR dashboard. 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. |
Let me double check w/ the ToolX team that there isn't an issue with these .Titles being in assemblies before I ack it. |
|
Hi @mburke5678, you can and should use the AsciiDocDITA Vale style to verify that the changes you make actually help prepare the modules and assemblies for DITA migration. This has been recommended on multiple calls, is more accurate than arbitrary In this situation, replacing a discrete heading with a block title replaces one problem with another as outside of procedures, where select few documented block titles are used to map content to correct DITA elements allowed in If you insist on having prerequisites in the assembly, which is not the correct approach in DITA, just remove the |
|
@jhradilek Can you explain this to me?
That doesn't make sense to me right off. Would you have a snippet module for each set of prerequisites? What if we change the |
|
@mburke5678 I got more detail from Jaromir today (as a preview of the preparing for migration session tomorrow). Apparently block titles are NOT able to be used on pretty much anything except in procedure modules as the .Prerequisites / .Procedure, etc. items. (And a few other items like a table, example, or figure). So, not even on lists in assemblies or concept or reference modules. Per the assembly template: https://raw.githubusercontent.com/redhat-documentation/modular-docs/refs/heads/main/modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc They do have == Prerequisites as a level 2 (==) heading that appears in the TOC. So I think the right answer for your content here is to remove the discrete headings (you can let it happen in my PR) and let it appear in the TOC. It's an assembly-wide prereq section, so I think it makes sense to appear in the TOC. (And bold text isn't really a heading, so that's not really the right change here). So my recommendation is to just close this PR and let my PR handle removing the discrete tags. |
|
@bergerhoffer Thank you for your helpful comment. I am closing this PR. All yours! |
Demoting instances of
== Prerequisitesto.Prerequisitesand removing the associated[discrete]tag to prep for DITA migration. See #96676Previews
Creating a Windows machine set on AWS
Creating a Windows machine set on Azure
Creating a Windows machine set on GCP
Creating a Windows MachineSet object on Nutanix
Creating a Windows machine set on vSphere
Disabling Windows container workloads
Enabling Windows container workloads
Scheduling Windows container workloads