Skip to content

[April CQA] Install doc master.adoc and spacing fixes#351

Merged
mpershina merged 2 commits intomainfrom
Install-CQA
Apr 13, 2026
Merged

[April CQA] Install doc master.adoc and spacing fixes#351
mpershina merged 2 commits intomainfrom
Install-CQA

Conversation

@mpershina
Copy link
Copy Markdown
Collaborator

@mpershina mpershina commented Apr 13, 2026

Tracked under:

Summary by CodeRabbit

  • Documentation
    • Cleaned up formatting inconsistencies across multiple installation documentation files
    • Reorganized the structure of the main installation guide for improved clarity

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b8df0cb8-e68a-4ae5-900c-b5449888db44

📥 Commits

Reviewing files that changed from the base of the PR and between 160573e and bf326e6.

📒 Files selected for processing (4)
  • assemblies/mta-install-title/assembly_installing-mta-ui.adoc
  • assemblies/mta-install-title/assembly_intro-to-mta.adoc
  • assemblies/mta-install-title/assembly_red-hat-build-of-keycloak.adoc
  • docs/install-guide/master.adoc

📝 Walkthrough

Walkthrough

AsciiDoc documentation files underwent whitespace cleanup and front-matter restructuring. Three assembly files had trailing whitespace removed from paragraphs, while the main installation guide document reorganized its attribute declarations, include statements, and section ID/title placement.

Changes

Cohort / File(s) Summary
Trailing Whitespace Cleanup
assemblies/mta-install-title/assembly_installing-mta-ui.adoc, assemblies/mta-install-title/assembly_intro-to-mta.adoc, assemblies/mta-install-title/assembly_red-hat-build-of-keycloak.adoc
Removed trailing whitespace at the end of paragraph sentences in AsciiDoc abstract/description blocks.
Master Document Front-Matter Reorganization
docs/install-guide/master.adoc
Removed :_mod-docs-content-type: ASSEMBLY attribute declaration and reordered placement of include::topics/templates/document-attributes.adoc[], [id="installing-mta-title"], and title assignment block. Reduced trailing blank lines after the title section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • Pkylas007
  • anarnold97

Poem

🐰 A rabbit hops through trailing spaces,
Cleaning whitespace in AsciiDoc places,
Front-matter shuffled with care,
Attributes ordered fair,
Documentation now shines through all traces! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: reorganization of the install doc master.adoc front-matter and removal of trailing whitespace across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch Install-CQA

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@@ -1,16 +1,15 @@
:mta:
include::topics/templates/document-attributes.adoc[]
:_mod-docs-content-type: ASSEMBLY
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Not sure about removing _mod-docs-content-type, but it should not be a requirement for the master.adoc file.

Otherwise, the issue was caused by the include::topics/templates/document-attributes.adoc[] include, which was placed before some attributes (context, toc...). I moved the reported attributes above this include to fix the issue.

Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 left a comment

Choose a reason for hiding this comment

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

LGTM

@mpershina mpershina merged commit 131cea3 into main Apr 13, 2026
2 checks passed
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.

2 participants