Skip to content

chore: remove legacy tool docs and directories and update documentation.#725

Merged
ejhenry merged 4 commits into
mainfrom
chore/remove-legacy-tools
Apr 29, 2025
Merged

chore: remove legacy tool docs and directories and update documentation.#725
ejhenry merged 4 commits into
mainfrom
chore/remove-legacy-tools

Conversation

@kpoineal
Copy link
Copy Markdown
Contributor

Overview/Summary

This PR does the following:

  • removes tools directory
  • removes legacy tools from the aprl docs site

Breaking Changes

  1. Legacy Tools are no longer accessible.
  2. Legacy Tools may not work as expected.

As part of this pull request I have

  • Read the Contribution Guide and ensured this PR is compliant with the guide
  • Checked for duplicate Pull Requests
  • Associated it with relevant GitHub Issues or ADO Work Items (Internal Only)
  • Ensured my code/branch is up-to-date with the latest changes in the main branch
  • Ensured PR tests are passing
  • Performed testing and provided evidence (e.g. screenshot of output) for any changes associated to ARG queries
  • Updated relevant and associated documentation (e.g. Contribution Guide, Docs etc.)

Copilot AI review requested due to automatic review settings April 28, 2025 14:43
@kpoineal kpoineal requested review from a team as code owners April 28, 2025 14:43
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR removes the legacy tool documentation and directories while updating the active collector documentation with additional configuration and runbooks sections.

  • Adds new "Configuration File" and "Runbooks" sections to the collector documentation to improve usability.
  • Removes legacy documentation for reports, analyzer, and overall legacy tools from the docs/content/tools-old directory.

Reviewed Changes

Copilot reviewed 15 out of 18 changed files in this pull request and generated no comments.

File Description
docs/content/tools/collector/_index.md Updated documentation by adding configuration and runbooks sections.
docs/content/tools-old/reports/_index.md Legacy reports documentation has been removed.
docs/content/tools-old/analyzer/_index.md Legacy analyzer documentation has been removed.
docs/content/tools-old/_index.md Overall legacy tools documentation has been removed.
Files not reviewed (3)
  • azure-resources/Network/virtualNetworkGateways/recommendations.yaml: Language not supported
  • tools/Version.json: Language not supported
  • tools/configfile.example: Language not supported
Comments suppressed due to low confidence (1)

docs/content/tools/collector/_index.md:168

  • [nitpick] Consider using consistent casing for the tenant identifier; the section header uses 'tenantId' while the example value is 'tenantid'.
tenantid

Copy link
Copy Markdown
Contributor

@DaFitRobsta DaFitRobsta left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@ejhenry ejhenry left a comment

Choose a reason for hiding this comment

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

LGTM

@ejhenry ejhenry merged commit 912d76b into main Apr 29, 2025
10 checks passed
@kpoineal kpoineal deleted the chore/remove-legacy-tools branch May 15, 2025 15:59
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.

6 participants