From 8f75f66d0149027af2179f7f9af93c71e9f81062 Mon Sep 17 00:00:00 2001 From: Issy Long Date: Sat, 8 Feb 2025 14:21:38 +0000 Subject: [PATCH] Review some docs - Most of these were fine still, apart from: - FAQ: `hub` is less maintained than `gh`. - Brew-Maintainer-Guide: link to GitHub docs on commit signing via GPG or SSH. - Interesting-Taps-and-Forks: remove outdated information about `homebrew/core` being in `Library/Taps`. - New-Maintainer-Checklist: remove outdated information about the `@members` team. --- docs/BrewTestBot.md | 2 +- docs/Creating-a-Homebrew-Issue.md | 2 +- docs/FAQ.md | 7 +++---- docs/Homebrew-brew-Maintainer-Guide.md | 4 ++-- docs/Interesting-Taps-and-Forks.md | 6 +++--- docs/Kickstarter-Supporters.md | 2 +- docs/Maintainer-Guidelines.md | 2 +- docs/Maintainers-Avoiding-Burnout.md | 2 +- docs/Migrating-A-Formula-To-A-Tap.md | 2 +- docs/New-Maintainer-Checklist.md | 7 +++---- docs/Prose-Style-Guidelines.md | 2 +- docs/Querying-Brew.md | 2 +- docs/Typechecking.md | 2 +- docs/Updating-Software-in-Homebrew.md | 2 +- docs/index.md | 2 +- 15 files changed, 22 insertions(+), 24 deletions(-) diff --git a/docs/BrewTestBot.md b/docs/BrewTestBot.md index f69812b993..2d74f2c439 100644 --- a/docs/BrewTestBot.md +++ b/docs/BrewTestBot.md @@ -3,7 +3,7 @@ logo: /assets/img/brewtestbot.png image: /assets/img/brewtestbot.png redirect_from: - /Brew-Test-Bot -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # BrewTestBot diff --git a/docs/Creating-a-Homebrew-Issue.md b/docs/Creating-a-Homebrew-Issue.md index d9d9e9d3e7..ec2e2025b4 100644 --- a/docs/Creating-a-Homebrew-Issue.md +++ b/docs/Creating-a-Homebrew-Issue.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Creating a Homebrew Issue diff --git a/docs/FAQ.md b/docs/FAQ.md index c269fe7bbe..99cb87f333 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # FAQ (Frequently Asked Questions) @@ -158,10 +158,9 @@ Ensure you have a [local copy of `homebrew/core`](#can-i-edit-formulae-myself), ```sh brew update -brew install hub +brew install gh cd "$(brew --repository homebrew/core)" -hub fetch github_username -hub pr checkout pull_request_number +gh pr checkout pull_request_number ``` ## Why was a formula deleted or disabled? diff --git a/docs/Homebrew-brew-Maintainer-Guide.md b/docs/Homebrew-brew-Maintainer-Guide.md index 8165dfa081..ed60b143df 100644 --- a/docs/Homebrew-brew-Maintainer-Guide.md +++ b/docs/Homebrew-brew-Maintainer-Guide.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Homebrew/brew Maintainer Guide @@ -15,7 +15,7 @@ PRs must meet the following conditions to be merged: - Have at least one maintainer approval. - Have passing CI (continuous integration). This is a _mandatory_ step. PRs with failing CI should _never_ be merged. See the [CI](#ci) section below for more information about `Homebrew/brew` CI. -If possible, PRs should also have GPG-signed commits (see the private `ops` repository for instructions on setting this up). +If possible, PRs should also have [signed commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). ### Automatic approvals diff --git a/docs/Interesting-Taps-and-Forks.md b/docs/Interesting-Taps-and-Forks.md index 4b7a4e28ce..d91a329bce 100644 --- a/docs/Interesting-Taps-and-Forks.md +++ b/docs/Interesting-Taps-and-Forks.md @@ -1,14 +1,14 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Interesting Taps and Forks A [tap](Taps.md) is Homebrew-speak for a Git repository containing additional formulae. -Homebrew has the capability to add (and remove) multiple taps to your local installation with the `brew tap` and `brew untap` commands; run `man brew` in your terminal for usage information. The main repository at , often called `homebrew/core`, is always built-in. +Homebrew has the capability to add (and remove) multiple taps to your local installation with the `brew tap` and `brew untap` commands; run `man brew` in your terminal for usage information. -Your taps are Git repositories located at `$(brew --repository)/Library/Taps`. +Your taps are Git repositories located at `$(brew --repository)/Library/Taps`. As a normal user, you usually won't see `homebrew/core` here anymore and that's OK - [normal usage is via the JSON API](https://brew.sh/2023/02/16/homebrew-4.0.0/). ## Unsupported interesting taps diff --git a/docs/Kickstarter-Supporters.md b/docs/Kickstarter-Supporters.md index 24d1328285..04d26f375f 100644 --- a/docs/Kickstarter-Supporters.md +++ b/docs/Kickstarter-Supporters.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Kickstarter Supporters diff --git a/docs/Maintainer-Guidelines.md b/docs/Maintainer-Guidelines.md index ce9c91a3e9..1101460d36 100644 --- a/docs/Maintainer-Guidelines.md +++ b/docs/Maintainer-Guidelines.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Maintainer Guidelines diff --git a/docs/Maintainers-Avoiding-Burnout.md b/docs/Maintainers-Avoiding-Burnout.md index 96f425119d..4cb10b07a2 100644 --- a/docs/Maintainers-Avoiding-Burnout.md +++ b/docs/Maintainers-Avoiding-Burnout.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Maintainers: Avoiding Burnout diff --git a/docs/Migrating-A-Formula-To-A-Tap.md b/docs/Migrating-A-Formula-To-A-Tap.md index 257c14d7cf..961e89cd80 100644 --- a/docs/Migrating-A-Formula-To-A-Tap.md +++ b/docs/Migrating-A-Formula-To-A-Tap.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Migrating a Formula to a Tap diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index fafd99c803..1661901b9c 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # New Maintainer Checklist @@ -107,15 +107,14 @@ The Project Leader, one other PLC member (ideally a maintainer) and one other TS - Make them owners on the [`machomebrew` private Slack](https://machomebrew.slack.com/admin) - Make them owners on the [`homebrew` private 1Password](https://homebrew.1password.com/people) -When they cease to be am owner, revoke or downgrade their access to all of the above. +When they cease to be an owner, revoke or downgrade their access to all of the above. ## Members -People who are either not eligible or willing to be Homebrew maintainers but have shown continued involvement in the Homebrew community may be admitted by a majority vote of the [Project Leadership Committee](https://docs.brew.sh/Homebrew-Governance#4-project-leadership-committee) to join the Homebrew GitHub organisation as [members](https://docs.brew.sh/Homebrew-Governance#2-members). +People who are either not eligible or willing to be Homebrew maintainers but have shown continued involvement in the Homebrew community may be admitted by a majority vote of the [Project Leadership Committee](https://docs.brew.sh/Homebrew-Governance#4-project-leadership-committee). When admitted as members: -- Invite them to the [**@Homebrew/members** team](https://github.com/orgs/Homebrew/teams/members), to give them access to the private governance repository. - Invite them as a single-channel guest to the #members channel on the [`machomebrew` private Slack](https://machomebrew.slack.com/admin/invites) (and ensure they've read the [communication guidelines](Maintainer-Guidelines.md#communication)) and ask them to use their real name there (rather than a pseudonym they may use on e.g. GitHub). - Add them to the current year's membership list in the [governance archives](https://github.com/Homebrew/brew/tree/master/docs/governance). diff --git a/docs/Prose-Style-Guidelines.md b/docs/Prose-Style-Guidelines.md index 3839eae019..8b7703c493 100644 --- a/docs/Prose-Style-Guidelines.md +++ b/docs/Prose-Style-Guidelines.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Prose Style Guidelines diff --git a/docs/Querying-Brew.md b/docs/Querying-Brew.md index d9f1cf44dc..2322112133 100644 --- a/docs/Querying-Brew.md +++ b/docs/Querying-Brew.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Querying `brew` diff --git a/docs/Typechecking.md b/docs/Typechecking.md index a4eaa0b95e..a7599ea936 100644 --- a/docs/Typechecking.md +++ b/docs/Typechecking.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Type Checking With Sorbet diff --git a/docs/Updating-Software-in-Homebrew.md b/docs/Updating-Software-in-Homebrew.md index 4aa1199dc6..1702dddf60 100644 --- a/docs/Updating-Software-in-Homebrew.md +++ b/docs/Updating-Software-in-Homebrew.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Updating Software in Homebrew diff --git a/docs/index.md b/docs/index.md index 679b769d10..5b71e7e8b1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,5 @@ --- -last_review_date: "1970-01-01" +last_review_date: "2025-02-08" --- # Documentation