Skip to content

fix(docs): restore reachability of alternative installation methods page (closes #1748)#1751

Merged
danielmeppiel merged 1 commit into
mainfrom
fix/1748-docs-install-reachable
Jun 11, 2026
Merged

fix(docs): restore reachability of alternative installation methods page (closes #1748)#1751
danielmeppiel merged 1 commit into
mainfrom
fix/1748-docs-install-reachable

Conversation

@danielmeppiel

Copy link
Copy Markdown
Collaborator

Restores the alternative installation methods page by removing the legacy redirect that sent /getting-started/installation back to /quickstart, and adds the page to the Start here sidebar so it is directly discoverable. How to test: npm --prefix docs run build; confirm docs/dist/getting-started/installation/index.html exists, contains Homebrew, Scoop, and air-gapped installation content, and no longer contains a meta refresh redirect to quickstart. Python ruff lint is N/A because this change touches only docs/astro.config.mjs. Closes #1748.

Remove the legacy redirect that sent getting-started/installation back to quickstart, and list the installation page in Start here so alternative install methods are reachable.\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 11, 2026 16:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 restores the reachability and discoverability of the “Alternative installation methods” documentation by removing the legacy redirect that forced /getting-started/installation/ back to /quickstart/, and by adding the Installation page to the “Start here” sidebar section.

Changes:

  • Removed the Astro redirect from /getting-started/installation to /apm/quickstart so the real page at docs/src/content/docs/getting-started/installation.md can be served.
  • Added “Installation” to the Starlight sidebar under “Start here” to make the page directly navigable.
Show a summary per file
File Description
docs/astro.config.mjs Removes the legacy installation redirect and adds the Installation page to the “Start here” sidebar for direct navigation.

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@danielmeppiel

Copy link
Copy Markdown
Collaborator Author

APM Review Panel: ship_now

Restores a silently broken funnel path: non-pip users can now discover Homebrew, Scoop, and air-gapped install docs without being bounced to quickstart.

cc @danielmeppiel @sergio-sisternes-epam -- a fresh advisory pass is ready for your review.

All panelists converge on ship with zero high-severity findings. The change is surgically scoped -- one file, two edits (redirect removal plus sidebar addition) -- and validated by a passing docs build that confirms the generated page exists with correct content and no residual meta-refresh redirect.

The only substantive discussion is a label-naming nit raised independently by DevX UX and OSS Growth: whether Installation should become Alternative Installation or Installation methods to disambiguate from the quickstart one-liner. CEO arbitration sides with leaving the label as Installation for this PR: the quickstart page is clearly branded as a 5-minute start, and adding qualifiers to adjacent labels adds cognitive load for the common case. If analytics show confusion post-merge, a follow-up rename is trivial.

Dissent. DevX UX and OSS Growth both suggested label rename options but diverged on direction. Neither is high-severity; current simplicity wins absent traffic data.

Aligned with: pragmatic_as_npm: users expect platform-specific install docs in an obvious location; oss_community_driven: fixes community-reported issue #1748.

Growth signal. This re-opens the Homebrew/Scoop/air-gapped install funnel that was silently closed by a legacy redirect. Watch docs analytics for install-page traffic recovery post-merge.

Panel summary

Persona B R N Takeaway
Python Architect 0 0 0 No Python source touched; docs-only config change is outside architectural scope.
CLI Logging Expert 0 0 0 No CLI output, logging, or console UX surface touched.
DevX UX Expert 0 0 1 Restoring the installation page at the correct sidebar position preserves discoverability.
Supply Chain Security Expert 0 0 0 No supply-chain surface touched; docs routing config only.
OSS Growth Hacker 0 0 1 Restoring the installation page re-opens a critical funnel path for non-pip users.
Doc Writer 0 0 1 Correctly restores the canonical installation page and repairs inbound links.

B = highest-severity findings, R = recommended, N = nits.
Counts are signal strength, not gates. The maintainer ships.

Recommendation

Merge as-is. The fix is validated, scoped to a single config file, and repairs a user-reported broken path. The label-naming suggestions are worth revisiting in a future docs-polish pass once post-merge traffic data is available, but do not warrant holding this PR.


Full per-persona findings

Python Architect

No findings.

CLI Logging Expert

No findings.

DevX UX Expert

  • [nit] Sidebar label could be more explicit.
    Users who completed quickstart already installed via the one-liner. A generic Installation label adjacent to Quickstart may cause some users to wonder which page to start with, but current sequencing is correct.

Supply Chain Security Expert

No findings.

OSS Growth Hacker

  • [nit] Sidebar label Installation could hint at breadth to increase click-through at docs/astro.config.mjs.
    The page covers Homebrew, Scoop, and air-gapped installs. Current label is functional; future analytics can justify copy polish.

Auth Expert -- inactive

PR #1751 touches only docs/astro.config.mjs; no auth, token, credential, host-resolution, or auth-header code paths are affected.

Doc Writer

  • [nit] Page frontmatter sidebar.order: 1 is inert under the explicit Start here items list at docs/src/content/docs/getting-started/installation.md:4.
    The explicit sidebar list wins over frontmatter ordering. Harmless for this PR, but future cleanup could remove the redundant key.

Test Coverage Expert -- inactive

Documentation-only PR -- no runtime code paths to defend.

Performance Expert -- inactive

PR touches only docs/astro.config.mjs; no dependency download, materialization, cache, transport, or perf-sensitive path is affected.

Lint contract

Python ruff lint pair is N/A for local shepherd changes because this PR touches only docs/astro.config.mjs and the shepherd made no .py edits. CI Lint is green on head 67f23dc. Docs validation run locally: npm --prefix docs run build; generated docs/dist/getting-started/installation/index.html exists with Homebrew, Scoop, and air-gapped content and no quickstart meta refresh.

CI

gh pr checks 1751 --repo microsoft/apm --watch reported all checks successful: 13 successful, 9 skipped, 0 failing, 0 pending (after 0 CI fix iterations).

Mergeability status

Captured from gh pr view 1751 --repo microsoft/apm --json mergeable,mergeStateStatus,statusCheckRollup immediately after CI observation.

PR head SHA CEO stance iters folds defers Copilot rounds CI mergeable mergeStateStatus notes
#1751 67f23dc ship_now 1 0 0 1 green MERGEABLE BLOCKED pending required review

Convergence

1 outer iteration; 1 Copilot round. Copilot reviewed the PR and generated 0 inline comments. Final panel stance: ship_now.

Ready for maintainer review.

This panel is advisory. It does not block merge. Re-apply the panel-review label after addressing feedback to re-run.

@danielmeppiel danielmeppiel merged commit ea0c62a into main Jun 11, 2026
23 checks passed
@danielmeppiel danielmeppiel deleted the fix/1748-docs-install-reachable branch June 11, 2026 17:48
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.

[BUG] [DOCS] Docs page of alternative installation methods is disabled - Missing information

2 participants