Uploaded image for project: 'Migration Toolkit for Applications'
  1. Migration Toolkit for Applications
  2. MTA-6511

[DOCS] Content duplication, near duplication, and overlapping content requiring refactoring

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • Documentation
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • False
    • None

      Duplicate Product Introduction Topics

      • docs/topics/what-is-the-toolkit.adoc and docs/topics/mta-intellij-plugin/what-is-the-toolkit.adoc — nearly identical content
      • docs/topics/mta-about-the-intro-to-mta-guide.adoc — overlapping "what is MTA" content

      Duplicate IDE Add-ons Topics

      • docs/topics/about-ide-addons.adoc and docs/topics/mta-intellij-plugin/about-ide-addons-intellij.adoc — identical content

      Duplicate JDK Prerequisites Snippets

      • docs/topics/snippet_jdk-hardware-mac-prerequisites.adoc and docs/topics/mta-intellij-plugin/snippet_jdk-hardware-mac-prerequisites.adoc — exact duplicates

      Duplicate Technology Preview / Developer Preview Admonitions (7 files)

      • docs/topics/snippets/technology-preview-admonition.adoc
      • docs/topics/templates/technology-preview-admonition.adoc
      • docs/topics/developer-lightspeed/technology-preview-admonition.adoc
      • docs/topics/snippets/developer-preview-admonition.adoc
      • docs/topics/snippets/developer-preview.adoc
      • docs/topics/templates/developer-preview.adoc
      • docs/topics/developer-preview-feature.adoc

      Duplicate Asset Generation Assemblies

      • assemblies/web-console-guide/assembly_asset-generation-ui.adoc and docs/topics/web-console/assembly_asset-generation-ui.adoc — nearly identical

      Duplicate Developer Lightspeed Getting Started Assemblies

      • assemblies/developer-lightspeed-guide/assembly_getting-started.adoc (empty shell) and docs/topics/developer-lightspeed/assembly_getting-started.adoc (complete content)

      IDE Profile Configuration Topics with Overlapping Content

      • docs/topics/vscode/proc_configuring-profile-settings.adoc and docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc — significant overlap

      Inconsistent Prerequisites Reuse

      • docs/topics/vscode/proc_installing-vscode-extension.adoc — inlines JDK prerequisites instead of using the shared snippet
      • docs/topics/mta-intellij-plugin/installing-intellij-idea-plugin.adoc — correctly uses the shared snippet

      IDE Issue Review Topics with Similar Structure

      • docs/topics/vscode/proc_vscode-reviewing-and-resolving-issues.adoc
      • docs/topics/mta-intellij-plugin/intellij-idea-plugin-reviewing-issues.adoc
      • docs/topics/mta-intellij-plugin/intellij-idea-plugin-resolving-issues.adoc

      Migration Paths List Duplicated

      • docs/topics/what-is-the-toolkit.adoc — lists migration paths inline
      • docs/topics/mta-intellij-plugin/what-is-the-toolkit.adoc — lists same paths inline
      • docs/topics/mta-cli/ref_supported-migration-paths.adoc — comprehensive reference exists but not reused

      Story Points / Effort Estimation Not Shared

      • assemblies/cli-guide/assembly_rule-story-points.adoc and docs/topics/mta-cli/ref_effort-level-estimation.adoc — could be reused in Rules Development and UI guides

              rhn-support-anarnold A Arnold
              rhn-support-anarnold A Arnold
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: