Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/Installation: make clear the env configs are advanced settings #16258

Merged
merged 1 commit into from Nov 30, 2023

Conversation

Bo98
Copy link
Member

@Bo98 Bo98 commented Nov 26, 2023

The Git remote section is fairly prominent, contains the first copy-paste code of this page and contains leading language such as "speed up Homebrew's installation" that make it sound like a desirable setting. This leads to confusion with people creating forks and setting the remotes to that.

Clarify these a bit by making it clearer that these are advanced settings, remove mentions of "speed up" and instead describe the git remote settings as something for those with issues connecting to GitHub.com.

docs/Installation.md Outdated Show resolved Hide resolved
docs/Installation.md Outdated Show resolved Hide resolved
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Good idea. A few wording suggestions to take things even further.

docs/Installation.md Outdated Show resolved Hide resolved
docs/Installation.md Show resolved Hide resolved
docs/Installation.md Outdated Show resolved Hide resolved
docs/Installation.md Outdated Show resolved Hide resolved
Co-authored-by: Kevin <apainintheneck@gmail.com>
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
@MikeMcQuaid
Copy link
Member

Great work, thanks again @Bo98!

@MikeMcQuaid MikeMcQuaid merged commit 1ff2fed into Homebrew:master Nov 30, 2023
27 checks passed
@Bo98 Bo98 deleted the install-docs-clearup branch November 30, 2023 13:16
@github-actions github-actions bot added the outdated PR was locked due to age label Dec 31, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants