MTA 8.1.0 attributes#330
Conversation
Signed-off-by: A.Arnold <anarnold@redhat.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated AsciiDoc template attributes in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/topics/templates/document-attributes.adoc`:
- Line 17: Several docs include hardcoded "8.0.0"/"/8.0/" references causing
mismatch with the :DocInfoProductNumber: 8.1 attribute; update those static
strings to use the version attribute or change them to 8.1. Edit the listed
files (developer-lightspeed/con_installation.adoc,
developer-lightspeed/con_intro-to-developer-lightspeed.adoc,
mta-ui/proc_configuring-generators.adoc,
vscode/proc_vscode-analyzing-application.adoc,
vscode/proc_configuring-lighstspeed-ide-settings.adoc,
vscode/proc_configuring-profile-settings.adoc) and replace the literal "8.0.0"
and URL path segments "/migration_toolkit_for_applications/8.0/" with the
document attribute (e.g., use {DocInfoProductNumber} or a dedicated version
attribute) or update them to "8.1" so the content is consistent with
:DocInfoProductNumber: 8.1.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a0811e76-601d-451c-bb6e-d0db8825d100
📒 Files selected for processing (1)
docs/topics/templates/document-attributes.adoc
| :ProductName: migration toolkit for applications | ||
| :DocInfoProductName: migration toolkit for applications | ||
| :DocInfoProductNumber: 8.0 | ||
| :DocInfoProductNumber: 8.1 |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Find all hardcoded MTA version references that may need updating
echo "=== Searching for hardcoded 8.0.x version strings ==="
rg -n --type=asciidoc -C2 '\b8\.0\.[0-9]'
echo -e "\n=== Searching for hardcoded 8.0 version strings (potential URL paths) ==="
rg -n --type=asciidoc -C2 'migration_toolkit_for_applications/8\.0/'
echo -e "\n=== Searching for MTA 8.0 in titles and headings ==="
rg -n --type=asciidoc -C1 '^=.*8\.0'
echo -e "\n=== Searching for version-specific release notes files ==="
fd -e adoc 'mta-8-0'Repository: migtools/mta-documentation
Length of output: 14196
🏁 Script executed:
# Check if installation files are version-specific or general current documentation
head -20 docs/topics/developer-lightspeed/con_installation.adoc
echo "---"
head -20 docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc
echo "---"
# Check if these files have context/scope attributes indicating they're for a specific version
grep -E "context|ProductVersion|version" docs/topics/developer-lightspeed/con_installation.adoc | head -10Repository: migtools/mta-documentation
Length of output: 2156
🏁 Script executed:
# Find which assemblies include the general documentation files
rg -l "con_installation|con_intro-to-developer-lightspeed" --type=asciidoc | head -20
echo "---"
# Check if these inclusions appear in version-specific release notes or general assemblies
rg "include.*con_installation" --type=asciidoc -B 2 | head -30Repository: migtools/mta-documentation
Length of output: 470
🏁 Script executed:
# Check the master.adoc file to understand if it's version-agnostic or version-specific
head -30 docs/developer-lightspeed-guide/master.adoc
echo "---"
# Check if assembly_getting-started.adoc is included in version-specific or general guides
rg -l "assembly_getting-started" --type=asciidoc | head -20Repository: migtools/mta-documentation
Length of output: 1096
🏁 Script executed:
# Check which files include the proc_vscode files with /8.0/ URLs
rg -l "proc_vscode-analyzing-application|proc_configuring-lighstspeed-ide-settings|proc_configuring-profile-settings" --type=asciidoc | head -20
echo "---"
# Check the content around the /8.0/ URL in one of these files
sed -n '20,30p' docs/topics/vscode/proc_vscode-analyzing-application.adocRepository: migtools/mta-documentation
Length of output: 465
Update hardcoded version references in general documentation modules.
The template attribute updates are correct. However, general documentation modules that will be included in the 8.1 build contain hardcoded version strings that should be updated to use attributes or removed. This creates inconsistency where dynamic attributes show 8.1.0 while static text references older versions.
Instances requiring updates:
docs/topics/developer-lightspeed/con_installation.adoc:10: "8.0.0"docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc:10: "Starting from 8.0.0"docs/topics/mta-ui/proc_configuring-generators.adoc:13: "8.0.0 operator"docs/topics/vscode/proc_vscode-analyzing-application.adoc:26:/migration_toolkit_for_applications/8.0/URL pathdocs/topics/vscode/proc_configuring-lighstspeed-ide-settings.adoc:38:/migration_toolkit_for_applications/8.0/URL pathdocs/topics/vscode/proc_configuring-profile-settings.adoc:45:/migration_toolkit_for_applications/8.0/URL path
Consider using document attributes for dynamic version references or updating these hardcoded values to 8.1.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/topics/templates/document-attributes.adoc` at line 17, Several docs
include hardcoded "8.0.0"/"/8.0/" references causing mismatch with the
:DocInfoProductNumber: 8.1 attribute; update those static strings to use the
version attribute or change them to 8.1. Edit the listed files
(developer-lightspeed/con_installation.adoc,
developer-lightspeed/con_intro-to-developer-lightspeed.adoc,
mta-ui/proc_configuring-generators.adoc,
vscode/proc_vscode-analyzing-application.adoc,
vscode/proc_configuring-lighstspeed-ide-settings.adoc,
vscode/proc_configuring-profile-settings.adoc) and replace the literal "8.0.0"
and URL path segments "/migration_toolkit_for_applications/8.0/" with the
document attribute (e.g., use {DocInfoProductNumber} or a dedicated version
attribute) or update them to "8.1" so the content is consistent with
:DocInfoProductNumber: 8.1.
3 participants
Summary by CodeRabbit