Skip to content

DITA rewrite: persistent-storage-using-lvms#3

Closed
aireilly wants to merge 5 commits intomainfrom
dita-rewrite-lvms-20260310-214748
Closed

DITA rewrite: persistent-storage-using-lvms#3
aireilly wants to merge 5 commits intomainfrom
dita-rewrite-lvms-20260310-214748

Conversation

@aireilly
Copy link
Copy Markdown
Owner

Summary

Refactored AsciiDoc files in storage/persistent_storage_local/persistent-storage-using-lvms.adoc for DITA conversion compatibility using LLM-guided rewriting.

Changes Applied

The following DITA issues were fixed through LLM-guided refactoring:

  • ShortDescription: Added [role="_abstract"] attributes to 44 modules
  • CalloutList: Transformed 32 callout lists to description lists with where: pattern
  • BlockTitle: Converted 5 .Example output block titles to inline text
  • TaskTitle: Fixed .Verification steps to .Verification

Files Processed

49 files were processed from the assembly and its includes (46 modules, 3 snippets).

Vale Validation Results (Actionable Issues Only)

Metric Count
Issues before 95
Issues after 13
Fixed 82
Improvement 86%

Remaining Actionable Issues

Rule Count
ConceptLink 4
TaskInclude 3
TaskStep 2
TaskSection 2
TaskContents 1
AssemblyContents 1

Issue Details

File:Line Rule Message Why Not Auto-Fixed
modules/lvms-about-adding-devices-to-a-vg.adoc:20 ConceptLink Move all links and cross references to Additional resources Inline links in concept body need human decision on relocation
modules/lvms-about-adding-devices-to-a-vg.adoc:30 ConceptLink Move all links and cross references to Additional resources Inline links in concept body need human decision on relocation
modules/lvms-about-adding-devices-to-a-vg.adoc:31 ConceptLink Move all links and cross references to Additional resources Inline links in concept body need human decision on relocation
modules/lvms-about-adding-devices-to-a-vg.adoc:32 ConceptLink Move all links and cross references to Additional resources Inline links in concept body need human decision on relocation
modules/lvms-installing-logical-volume-manager-operator-disconnected-environment.adoc:22 TaskInclude Included file may introduce content that cannot be mapped to DITA steps Informational — included snippet needs manual review
modules/lvms-scaling-storage-of-clusters-using-cli.adoc:29 TaskInclude Included file may introduce content that cannot be mapped to DITA steps Informational — included snippet needs manual review
modules/lvms-scaling-storage-of-clusters-using-web-console.adoc:27 TaskInclude Included file may introduce content that cannot be mapped to DITA steps Informational — included snippet needs manual review
modules/lvms-installing-logical-volume-manager-operator-using-rhacm.adoc:12 TaskStep Content other than a single list cannot be mapped to DITA steps Complex nested content requires manual review of list structure
modules/lvms-reusing-vg-from-prev-installation.adoc:62 TaskStep Content other than a single list cannot be mapped to DITA steps Complex nested content requires manual review of list structure
modules/lvms-monitoring-logical-volume-manager-operator.adoc:1 TaskContents The .Procedure block title is missing Module has subsections that need structural decisions
modules/lvms-monitoring-logical-volume-manager-operator.adoc:22 TaskSection Sections are not allowed in DITA tasks Subsections need splitting into separate modules
modules/lvms-monitoring-logical-volume-manager-operator.adoc:46 TaskSection Sections are not allowed in DITA tasks Subsections need splitting into separate modules
storage/persistent_storage_local/persistent-storage-using-lvms.adoc:20 AssemblyContents Content other than additional resources cannot follow include directives Assembly text between includes needs manual relocation

Common reasons issues are not auto-fixed:

  • ConceptLink: Inline links in concept modules need human judgment on whether to move to Additional resources
  • TaskInclude: Informational — included snippets may not map cleanly to DITA steps
  • TaskStep: Complex nested content requires manual review of list structure
  • TaskSection: Subsections in procedures need structural decisions about splitting
  • TaskContents: Module structure needs human review before adding .Procedure
  • AssemblyContents: Assembly text between includes needs manual relocation to modules

Test Plan

  • Verify the AsciiDoc renders correctly
  • Run DITA conversion on the modified files
  • Content meaning preserved
  • Links and cross-references work

Generated with Claude Code

aireilly and others added 5 commits March 10, 2026 21:53
…bility

Applied dita-add-shortdesc-abstract to all LVMS modules to add
missing [role="_abstract"] attributes for DITA short description support.

Co-Authored-By: Claude <noreply@anthropic.com>
Applied dita-callouts --rewrite-deflists to 21 files to convert
callout markers to description lists for DITA compatibility.

Co-Authored-By: Claude <noreply@anthropic.com>
Added [role="_abstract"] attribute before the first paragraph in all
41 remaining LVMS modules for DITA short description support.

Co-Authored-By: Claude <noreply@anthropic.com>
- Convert .Example output block titles to inline text
- Fix .Verification steps -> .Verification

Co-Authored-By: Claude <noreply@anthropic.com>
Manually transformed JSON output callouts to description list and
converted .Example output block title to inline text.

Co-Authored-By: Claude <noreply@anthropic.com>
@aireilly aireilly closed this Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant