Skip to content

Use aka.ms/apm-unix and aka.ms/apm-windows short URLs for install scripts#384

Merged
danielmeppiel merged 3 commits intomainfrom
copilot/update-readme-documentation-links
Mar 20, 2026
Merged

Use aka.ms/apm-unix and aka.ms/apm-windows short URLs for install scripts#384
danielmeppiel merged 3 commits intomainfrom
copilot/update-readme-documentation-links

Conversation

Copy link
Contributor

Copilot AI commented Mar 20, 2026

Description

Replace raw.githubusercontent.com/microsoft/apm/main/install.{sh,ps1} URLs with aka.ms/apm-unix and aka.ms/apm-windows across README, docs, CLI output, and install script.

Shorter, memorable, and Microsoft-branded.

Before:

curl -sSL https://raw.githubusercontent.com/microsoft/apm/main/install.sh | sh
irm https://raw.githubusercontent.com/microsoft/apm/main/install.ps1 | iex

After:

curl -sSL https://aka.ms/apm-unix | sh
irm https://aka.ms/apm-windows | iex
  • README.md — both platform install commands
  • 6 doc pages — installation, quick-start, index, ci-cd, runtime-compat, cli-reference
  • update.py_get_update_installer_url() and _get_manual_update_command() now use aka.ms
  • install.sh — usage comment updated; private-repo auth examples intentionally kept on raw URL (auth headers don't survive redirects)
  • CHANGELOG.md — entry under Unreleased

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Maintenance / refactor

Testing

  • Tested locally
  • All existing tests pass
  • Added tests for new functionality (if applicable)

Updated test_update_command.py assertions to match new URLs. All 3 update command tests pass.


⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

…t links

Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/apm/sessions/82dde4ed-96da-4e87-8c47-06d1a52cf8d8
Copilot AI changed the title [WIP] Update readme and documentation links for install scripts Use aka.ms/apm-unix and aka.ms/apm-windows short URLs for install scripts Mar 20, 2026
Copilot AI requested a review from danielmeppiel March 20, 2026 09:27
@danielmeppiel danielmeppiel marked this pull request as ready for review March 20, 2026 09:29
Copilot AI review requested due to automatic review settings March 20, 2026 09:29
Copy link
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

Updates APM installation and update references to use the shorter aka.ms/apm-unix and aka.ms/apm-windows URLs across the CLI, installer script comment, and documentation, so users see consistent, memorable install commands.

Changes:

  • Switch apm update installer URL + manual update instructions to aka.ms/apm-unix / aka.ms/apm-windows, and update unit tests accordingly.
  • Replace raw.githubusercontent.com/.../install.{sh,ps1} with the aka.ms short URLs across docs pages and README snippets.
  • Add a CHANGELOG entry describing the install URL change under Unreleased.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/apm_cli/commands/update.py Uses aka.ms short URLs for updater download + manual update command output.
tests/unit/test_update_command.py Updates assertions to match the new updater URLs.
install.sh Updates the usage comment to the new aka.ms install URL.
docs/src/content/docs/reference/cli-commands.md Updates manual update docs to the new aka.ms URLs.
docs/src/content/docs/integrations/runtime-compatibility.md Updates install snippet to the new Unix aka.ms URL.
docs/src/content/docs/integrations/ci-cd.md Updates CI install snippet to the new Unix aka.ms URL.
docs/src/content/docs/index.mdx Updates homepage install snippets to the new aka.ms URLs.
docs/src/content/docs/getting-started/quick-start.md Updates quick-start install snippets to the new aka.ms URLs.
docs/src/content/docs/getting-started/installation.md Updates installation page snippets to the new aka.ms URLs.
README.md Updates README install snippets to the new aka.ms URLs.
CHANGELOG.md Adds an Unreleased entry for the install URL change.

@danielmeppiel danielmeppiel merged commit 74f4b68 into main Mar 20, 2026
13 checks passed
@danielmeppiel danielmeppiel deleted the copilot/update-readme-documentation-links branch March 20, 2026 10:08
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.

3 participants