Mike McQuaid
8adc188992
Import brew alias and brew unalias commands
...
Import these from the homebrew/aliases tap and deprecate that tap.
This required a little messing around with class/module/constant names
to get `brew tests` and `brew typecheck` to play nicely.
I added also added Sorbet type signatures and integration tests.
2025-02-07 14:31:50 +00:00
Issy Long
31d7bcc583
Add a last_reviewed_date to docs metadata
...
- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
documentation, so that we can periodically implement a review
mechanism (GitHub Actions posts to Slack for a regular documentation
outdatedness check?) to track how old docs are and ensure they're
still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
to the metadata of all docs with a date of earlier than Homebrew's
inception because everything needs reviewing so that we start from a
good base!
2025-02-03 11:56:07 +00:00
Mike McQuaid
c13700af00
Use repository consistently instead of repo
...
The documentation linting job doesn't like `repo` so let's fix this
globally rather than naming it differently in documentation and code.
2024-06-10 09:31:53 +01:00
Patrick Linnane
7362c9c727
docs: clarify upstream taps
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-21 19:00:54 -07:00
EricFromCanada
9cc4766d33
docs: hyperlink updates
...
plus some reformatting
2022-12-06 12:52:03 -05:00
EricFromCanada
d615899ca9
Contributors docs: content & formatting updates
...
Update How-To-Open-a-Homebrew-Pull-Request.md
Update Acceptable-Formulae.md
Update Acceptable-Casks.md
Update License-Guidelines.md
Update Versions.md
Update Versions.md
Update Deprecating-Disabling-and-Removing-Formulae.md
Update Node-for-Formula-Authors.md
Update Python-for-Formula-Authors.md
Update Brew-Livecheck.md
Update Migrating-A-Formula-To-A-Tap.md
Update Rename-A-Formula.md
Update How-to-Create-and-Maintain-a-Tap.md
Update Brew-Test-Bot.md
Update Typechecking.md
2022-11-16 09:03:12 -05:00
EricFromCanada
034bf72235
Contributors docs: adjust line breaks
2022-11-16 09:03:12 -05:00
Dustin Rodrigues
cb509229f9
docs/create-tap: remove nbsp
2020-10-22 19:25:07 -04:00
Peter Wu
89bd6a76ee
docs: clarify Formula location in Tap repositories
...
Make clear that Formula locations cannot be mixed, they are mutually
exclusive. This avoids the (false) implication that top-level Formula
can override those in the Formula subdirectory.
This makes no change in recommendations following the original
discussion in https://github.com/Homebrew/legacy-homebrew/pull/41858
2020-06-11 11:49:36 +02:00
Mike McQuaid
4cdc2a5c81
docs/How-to-Create-and-Maintain-a-Tap: official vendor taps.
...
Explain our policies around "Official Vendor Taps" and clarify the
formulae naming section.
Inspired by discussion in
https://discourse.brew.sh/t/maintenance-of-formulas-by-vendor/7649/ .
2020-05-10 14:15:27 +01:00
Takashi Idobe
9cf43a181c
grammar fix for How-To-Create-and-Maintain-a-Tap
...
changing `with you github username` to `with your github username`.
2020-05-09 09:55:09 -05:00
Mike McQuaid
70f232ada5
Merge pull request #6537 from tomjonandy/docs/cask-tap
...
Docs: Add cask instructions to tap docs
2019-10-11 09:30:45 +01:00
Mike McQuaid
33f38553a6
Merge pull request #6575 from MikeMcQuaid/brew-tap-docs
...
How-to-Create-and-Maintain-a-Tap: note `brew tap-new`.
2019-10-10 11:52:40 +01:00
Mike McQuaid
212c197886
How-to-Create-and-Maintain-a-Tap: note brew tap-new.
...
A bit of a glaring omission I noticed.
2019-10-10 11:22:41 +01:00
Xiaodong
157a9191e3
Fix minor typo in How-to-Create-and-Maintain-a-Tap
2019-10-10 18:17:06 +08:00
Thomas Andrew
7855bb88b6
Add cask instructions to tap docs
...
Loosely based on (now deleted) 4c72606867/doc/alternate_cask_taps.md
2019-10-05 13:40:12 +01:00
Steven Peters
4320b1478c
How-to-Create-and-Maintain-a-Tap.md add missing )
2019-01-27 16:11:02 -08:00
Mike McQuaid
de08f33cc3
docs/How-to-Create-and-Maintain-a-Tap: naming to avoid clashes.
...
As requested in:
https://github.com/Homebrew/brew/issues/5615#issuecomment-457816870
2019-01-26 19:08:25 +00:00
Sean Molenaar
96e18d71fa
Clear up tap naming
...
Explain the recommendation to use the homebrew- prefix.
As pointed out in: https://discourse.brew.sh/t/couldnt-tap-github-repo-without-homebrew-prefix/3178/2
2018-10-24 09:12:42 +02:00
EricFromCanada
31dbc4f985
Various documentation edits
...
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
Mike McQuaid
49038a2cd9
Remove mentions to official taps
...
There are none remaining. We don’t want PHP to get the deprecated
messages until all formulae have been deleted so that will be in a
later PR.
2018-03-31 13:42:33 +01:00
Mike McQuaid
190e665bb1
Revert "docs: use short links."
...
This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a.
Closes #3832 .
2018-02-23 19:52:00 +00:00
Mike McQuaid
e63a2ee8de
docs: use short links.
2018-02-22 19:25:44 +00:00
EricFromCanada
f34f4e80f8
docs: rename Taps docs to match convention
2017-11-17 16:40:37 -05:00
EricFromCanada
dc7f74210a
docs: code example reformatting
...
Add labeled fences to most code blocks, monospace terms where
appropriate, omit "$" when referring to variables
2017-03-25 22:53:33 -04:00
EricFromCanada
ab4d1a1574
docs: grammar edits, sentence-case secondary headings
...
Also changes some heading levels so only one primary
heading appears per page.
2017-03-19 14:03:39 -04:00
Kare Morstol
1206e9e3f2
Remove double space.
2017-03-17 22:53:35 +01:00
Kare Morstol
988b4e5f8a
Fix small typos in How-to-Create-and-Maintain-a-Tap.md
2017-03-17 00:19:58 +01:00
Jonathan Chang
9a6cd9b83f
docs: fix titles on docs.brew.sh
2017-01-04 16:16:00 -06:00
Mike McQuaid
bd6fb88ddc
Rearrange repository files.
2016-09-20 10:41:42 +01:00
