Skip to content

implement Installation.md and document using setup-go#2190

Merged
gdams merged 8 commits intomicrosoft/mainfrom
dev/gadams/docs
Mar 18, 2026
Merged

implement Installation.md and document using setup-go#2190
gdams merged 8 commits intomicrosoft/mainfrom
dev/gadams/docs

Conversation

@gdams
Copy link
Member

@gdams gdams commented Mar 17, 2026

Consolidates installation methods into a single markdown file with bullet links from the README.md and Migration Guide

@gdams gdams requested a review from a team as a code owner March 17, 2026 13:42
Copilot AI review requested due to automatic review settings March 17, 2026 13:42
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

Consolidates end-user installation instructions for the Microsoft build of Go into a dedicated eng/doc/Installation.md, and updates existing docs to point to that centralized guide.

Changes:

  • Add a new eng/doc/Installation.md containing installation options (packages, CI integrations, archives, and build-from-source).
  • Replace the README “Download and install” content with a short, linked list of installation methods.
  • Update the Migration Guide to reference the new Installation guide for CI acquisition guidance.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
eng/doc/MigrationGuide.md Points CI install guidance to the new Installation guide, but needs follow-up link fixes for removed README anchors / removed internal section anchor.
eng/doc/Installation.md New consolidated installation doc (needs a few doc/link corrections).
README.md Replaces inline install instructions with links into eng/doc/Installation.md.

gdams and others added 3 commits March 17, 2026 13:50
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Updated link in MigrationGuide.md to point to Installation.md.
Co-authored-by: Quim Muntal <qmuntaldiaz@microsoft.com>
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

This PR consolidates installation documentation into a dedicated eng/doc/Installation.md page and updates existing docs to link to it, reducing duplication between the README and migration guidance.

Changes:

  • Added eng/doc/Installation.md to centralize all supported installation methods (OS packages, CI, scripts, archives, and source builds).
  • Updated README.md to replace the detailed install section with a short, linked table-of-contents style list.
  • Updated eng/doc/MigrationGuide.md to reference the new Installation guide (including CI guidance for Azure Pipelines and GitHub Actions).

Reviewed changes

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

File Description
eng/doc/MigrationGuide.md Repoints installation guidance to Installation.md and adds links for CI-specific installation approaches.
eng/doc/Installation.md New consolidated installation guide covering all supported acquisition/install paths.
README.md Replaces duplicated install instructions with bullet links into eng/doc/Installation.md.

Corrected the link to the Installation Guide for Ubuntu golang package.
@gdams gdams requested a review from dagood March 17, 2026 15:31
README.md Outdated
`eng/run.ps1` and other repository infrastructure.

Once built, the Microsoft build of Go binary is found at `go/bin/go`.
The following installation methods are available. See [Installation](eng/doc/Installation.md) for full details.
Copy link
Member

Choose a reason for hiding this comment

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

I think we should try to make sure it doesn't seem like "full details" are different from what you get by clicking one of the links below.

Suggested change
The following installation methods are available. See [Installation](eng/doc/Installation.md) for full details.
The [Installation](eng/doc/Installation.md) documentation contains sections describing each of the following installation methods:

@dagood
Copy link
Member

dagood commented Mar 17, 2026

@gdams gdams enabled auto-merge (squash) March 17, 2026 21:13
@dagood
Copy link
Member

dagood commented Mar 17, 2026

FYI: I have some polishing that I plan to put in separate PRs--will include my suggestion in that.

@gdams gdams merged commit 9be7a71 into microsoft/main Mar 18, 2026
42 checks passed
@gdams gdams deleted the dev/gadams/docs branch March 18, 2026 01:00
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.

4 participants