Skip to content

[MTA] Broken links fixes for MTA docs#328

Merged
anarnold97 merged 1 commit intomainfrom
link-fixes
Mar 11, 2026
Merged

[MTA] Broken links fixes for MTA docs#328
anarnold97 merged 1 commit intomainfrom
link-fixes

Conversation

@mpershina
Copy link
Collaborator

@mpershina mpershina commented Mar 11, 2026

Summary by CodeRabbit

  • Documentation
    • Enhanced prerequisites documentation for running the containerless MTA CLI with clearer guidance on environment variables, Maven, Java, and Gradle setup requirements.
    • Updated and corrected documentation links across MTA topics for improved reference accuracy and accessibility.

@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 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: b6670f6c-e4ec-451b-a16e-8209680e61ef

📥 Commits

Reviewing files that changed from the base of the PR and between e600b61 and 6cb4439.

📒 Files selected for processing (4)
  • docs/topics/mta-cli/proc_running-the-containerless-mta-cli.adoc
  • docs/topics/mta-install/con_mta-rules.adoc
  • docs/topics/mta-ui/con_intro-to-mta-ui.adoc
  • docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-0.adoc

📝 Walkthrough

Walkthrough

This PR updates MTA documentation by standardizing documentation URLs to use templated {mta-URL} references, fixing a CLI installation link, and expanding prerequisite and procedure sections with additional setup guidance for containerless CLI deployment.

Changes

Cohort / File(s) Summary
URL Standardization
docs/topics/mta-ui/con_intro-to-mta-ui.adoc, docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-0.adoc
Replaced hardcoded documentation URLs with templated {mta-URL} references for consistency and maintainability.
CLI Documentation Enhancement
docs/topics/mta-cli/proc_running-the-containerless-mta-cli.adoc
Fixed CLI installation URL link path and expanded prerequisites with guidance on mvn PATH configuration, JAVA_HOME and JVM_MAX_MEM environment variables, and Gradle setup requirements.
Rules Documentation Link Update
docs/topics/mta-install/con_mta-rules.adoc
Updated custom rules documentation link target from Rules Development Guide to Configuring and using rules page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • Pkylas007
  • mguetta1

Poem

🐰 URLs once scattered, now align,
With templated paths that brightly shine,
Prerequisites expanded, guidance true,
Our docs are cleaner, fresh, and new! ✨

🚥 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 clearly indicates the main purpose: fixing broken links in MTA documentation 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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch link-fixes

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.

@anarnold97 anarnold97 merged commit 7a9a933 into main Mar 11, 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