Mike McQuaid
d661cffc1f
Switch to using main as the default branch
...
Homebrew/brew has moved to a `main` default branch so we can more move
references from `master` to `main`.
2025-06-24 11:14:57 +01:00
Eric Knibbe
6a07851c46
docs: localize internal URLs
2025-05-22 12:17:52 -04:00
Sean Molenaar
aa66185489
fix: make the "Open Pull Request" doc less daunting
2025-05-08 09:48:54 +02: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
Paul Bissex
a014e75cff
Update How-To-Open-a-Homebrew-Pull-Request.md
...
One-character correction
2025-01-29 22:18:25 -05:00
Ryan Schumacher
ff6df8ee56
Update How-To-Open-a-Homebrew-Pull-Request.md
...
Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2024-08-29 18:45:10 -05:00
Ryan Schumacher
b31a9b922e
Apply suggestions from code review
...
Co-authored-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2024-08-29 15:55:12 -05:00
Ryan Schumacher
e5a3f0e583
Update docs/How-To-Open-a-Homebrew-Pull-Request.md
...
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2024-08-29 15:54:32 -05:00
Ryan Schumacher
72f995599d
Update docs/How-To-Open-a-Homebrew-Pull-Request.md
...
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2024-08-29 08:48:45 -05:00
Ryan Schumacher
010304a9a1
Update docs/How-To-Open-a-Homebrew-Pull-Request.md
...
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2024-08-29 08:48:39 -05:00
Ryan Schumacher
f119b4a6d0
Added the block for casks
2024-08-29 08:28:18 -05:00
Ryan Schumacher
ff8b3f21f9
Move to appropriate section and resolve lint error
2024-08-29 08:19:34 -05:00
Ryan Schumacher
5fb6a8b8e3
Add link to Acceptable Formulae and slight wording change for more clarity.
2024-08-29 08:17:22 -05:00
Ryan Schumacher
8c6aa176f6
Add note about auditor to How-To-Open-a-Homebrew-Pull-Request.md
2024-08-29 05:17:26 -05:00
Muescha
56ec4363eb
Update How-To-Open-a-Homebrew-Pull-Request.md: add links to Manpage
...
add links to Manpage
2024-07-18 15:29:36 +02:00
Patrick Linnane
e98808e566
docs: update language on commit messages & notability
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-03-01 11:05:08 -08:00
Eric Knibbe
484efe2911
docs: various additions & changes
2023-09-05 01:06:31 -04:00
Eric Knibbe
b6c49b7a2d
docs: assume core repositories are untapped
2023-07-24 09:55:56 -04:00
Andrej Valek
f350c9ded0
docs: Add info about tap creation
...
Tap directories for furmulae/casks have to be created manually.
Signed-off-by: Andrej Valek <andy@skyrain.eu>
2023-07-10 13:38:08 +02: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
Sean Molenaar
7111f848fb
docs: incorporate suggestions
...
Co-authored-by: Rylan Polster <rslpolster@gmail.com>
Co-authored-by: Bevan Kay <bevanjkay@gmail.com>
2021-12-23 09:47:20 +01:00
Sean Molenaar
bc1d38761f
docs: document how to add/update casks
2021-12-22 19:48:12 +01:00
XuehaiPan
3f96d963f7
style: fix inconsistent code style for shell scripts
2021-09-15 14:59:01 +08:00
Mike McQuaid
e5dfed1b3b
docs/How-To-Open-a-Homebrew-Pull-Request: don't install with debug/verbose.
2021-07-26 13:14:28 +01:00
kraktus
c3bbd110d6
Docs: better flags for build/test commands
...
When creating a new formula, `--build-from-source` should be added. Adding the `--online` flag make the test more thorough.
2021-07-25 20:14:45 +02:00
Mike McQuaid
1eefc4c584
Adjust documentation for devel deprecation.
...
Update the documentation to be consistent with #7688 .
2020-06-10 09:06:36 +01:00
Issy Long
ed4cc753d1
docs: Make 'how to open a PR' title match filename
...
- This is a bit of a cheat to get around the titlecase lint. But I
wasn't sure whether to ignore it or not. And there've been previous
comments about making filenames match titles, so...
2019-12-18 16:09:08 +00:00
EricFromCanada
292361eaf0
docs: move sample commands into code blocks
2018-10-01 16:01:27 -04:00
Mike McQuaid
c1376f9f18
docs: various updates.
...
I read through the docs locally and made various fixes.
2018-09-06 15:07:00 +01: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
Mike McQuaid
fab0ea6fda
Deprecate Homebrew/homebrew-science
2018-01-01 09:33:43 +00:00
EricFromCanada
0441ecd3d7
docs: update for homebrew-nginx migration
2017-11-17 16:37:22 -05: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
EricFromCanada
c0468a3266
docs: add markers to ordered lists and sublists
...
While GitHub allows a single space to denote a sublist, Jekyll is not
so lenient. It also seems unable to handle ordered sublists.
2017-03-12 21:01:00 -04:00
EricFromCanada
ca0071ffc9
Grammar fixes for docs
...
Fixes to spelling and punctuation for consistency and readability.
2017-02-23 12:20:07 -05:00
EricFromCanada
20bb0aae80
Fix broken or inactive URLs
...
Bare URLs are auto-linked on GitHub but not on docs.brew.sh, so I added
angle brackets around them where appropriate. Also converted
Markdown-linked URLs for clarity.
2017-02-23 12:09:01 -05:00
Mike McQuaid
127e9def50
Cleanup documentation site
...
GitHub now nicely generates a documentation site for us at
http://brew.sh/brew based on our docs folder. Optimise the output of
this and the GitHub docs directory for readability and the various user
groupings.
2017-01-04 10:53:21 +00:00
