56 Commits

Author SHA1 Message Date
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
Issy Long
5dfdfe387f
Unlink localhost:4000 - it doesn't need to be a link 2025-02-03 13:23:20 +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
Eric Knibbe
e1f8b622ff
docs: add webrick gem, generation info 2024-05-13 14:13:07 -04:00
Eric Knibbe
7fa82cccf3
docs: rename README.md to index.md 2024-05-13 14:09:44 -04:00
Patrick Linnane
3080c2b209
docs: Brew Test Bot -> BrewTestBot
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-02-15 09:26:50 -08:00
Patrick Linnane
a09c47b0fa
docs: update links for BrewTestBot maintainer doc
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-02-15 09:10:59 -08:00
Issy Long
a8beb98bad
PRs raised at 2am are only half done, zzzz 2024-02-05 15:49:40 +01:00
Caleb Xu
892128304c
docs: add documentation about reproducible builds 2023-07-18 13:03:12 -04:00
Mike McQuaid
75dd070395
Remove Google Analytics
We are now entirely migrated to InfluxDB so can remove all GA code.
2023-06-16 10:33:15 +01:00
Mike McQuaid
7d09b90fff
docs/README: improve rubydoc.brew.sh link
This shouldn't really be maintainers only.

Fixes https://github.com/Homebrew/brew/issues/15026
2023-03-21 17:50:49 +00: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
5e23ad46cd
docs: add automatic listing of governance archives 2022-05-01 21:37:20 -04:00
Mike McQuaid
b59f7ca74f
Update Homebrew's governance documentation.
This is imported from the private repository agreed upon by the PL, PLC
and TSC.
2022-03-31 12:08:12 +01:00
Mike McQuaid
e1120549e5
Cleanup more linuxbrew-core code
- Add the same macOS `--build-from-source` default prefix behaviour
  now we have ~4000 linuxbrew-core bottles.
- Merge remaining useful linuxbrew-core-Maintainer-Guide into
  Homebrew-homebrew-core-Maintainer-Guide
- Don't special-case linuxbrew-core any more in docs
2021-10-21 09:00:22 +01:00
Rylan Polster
52f4025c61
docs: rename core maintainer guide for consistency 2021-05-19 12:52:28 -04:00
Rylan Polster
de5fd4642d
docs: update based on suggestions from code review
Co-Authored-By: Eric Knibbe <3324775+EricFromCanada@users.noreply.github.com>
2021-05-14 13:49:16 -04:00
Rylan Polster
ce2a942d67
docs: temporarily rename core maintainer guide 2021-05-13 02:34:31 -04:00
Rylan Polster
e0230330d0
docs: add brew maintainer guide 2021-05-13 02:30:01 -04:00
Rylan Polster
068292cfdc
docs: reorganize maintainer guides 2021-05-12 20:59:09 -04:00
Rylan Polster
0f47290622
docs: add cask maintainer guide 2021-05-12 20:54:06 -04:00
Sean Molenaar
390d108555
docs: add Cask Cookbook 2021-04-26 10:47:41 +02:00
Sean Molenaar
0aed1fc62e
Docs: Migrate casks FAQ 2021-02-09 13:11:45 +01:00
Sam Ford
308390ba5b
Address feedback and expand documentation
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
Co-authored-by: Sean Molenaar <1484494+SMillerDev@users.noreply.github.com>
2021-01-11 17:51:41 -05:00
Sam Ford
94f900ea87
docs: add brew livecheck documentation 2021-01-11 15:58:49 -05:00
Rylan Polster
e0badc90e0 docs: add deprecate/disable/removal documentation 2020-12-24 22:42:43 -05:00
Jonathan Chang
15a56655c8 docs: move supporters into its own group 2020-09-09 19:21:22 +10:00
Claudia
f4d81fee1c
Add flowchart for managing pull requests
- Add flowchart for handling ready-to-merge pull requests

- Add diagram guidelines

Many thanks to Sean Molenaar for the idea and initial version of the
chart.

CC: Sean Molenaar <smillernl@me.com>
2020-09-06 14:54:28 +02:00
Mike McQuaid
995eb3a1c4
Merge pull request #8386 from vidusheeamoli/documentation
docs: add sorbet documentation
2020-08-27 15:03:00 +01:00
Rylan Polster
3c55d8e528 docs: update license documentation 2020-08-25 17:22:35 -04:00
vidusheeamoli
cba751a343 docs: add sorbet documentation
(cherry picked from commit 022571489a0f94ed54a0908167b553592cfe3277)
2020-08-21 21:22:39 +05:30
Adrian Ho
09dcdc2a6b README.md: Add link to Homebrew blog
Inspired by https://github.com/Homebrew/brew/issues/8096 and https://github.com/Homebrew/brew/pull/8098. I think the blog is an important way for regular users to keep up-to-date with Homebrew evolution, so it deserves an entry in the main docs page.

Update docs/README.md

Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2020-07-27 17:03:12 +08:00
Adrian Ho
a0df23ec8d Fix broken link on docs man page 2020-03-09 17:20:59 +08:00
Sean Molenaar
10f529d091
Docs: Add guides for common cases
Co-authored-by: Sam Ford <1584702+samford@users.noreply.github.com>
2020-02-25 21:43:03 +01:00
Mike McQuaid
605a9c6057
Merge pull request #6440 from igas/formula-pr-checklist
Maintainer's checklist on accepting formula PR
2019-09-18 11:47:43 +01:00
Issy Long
23294a5647
Docs: Add a link to the linuxbrew-core maintainer guide 2019-09-15 11:56:26 +01:00
Igor Kapkov
2ec526609c
Add link, rename file and remove semicolons 2019-09-12 07:36:17 +10:00
Izaak Beekman
68288b3495
Add link to rubydoc.brew.sh to docs landing page 2019-06-06 11:20:05 -04:00
Mike McQuaid
710859e300
Update Linuxbrew references to Homebrew on Linux
This is a clearer branding for us to use.

Also, as part of testing this, make some fixes to Jekyll in the docs folder.

Fixes #5835
2019-03-12 20:13:38 +00:00
Mike McQuaid
aafcbc1153
Add/link Homebrew Governance document. 2019-02-15 10:54:30 +00:00
Mike McQuaid
1b609ceeb3
Update maintainer documentation.
- Fix Markdown format
- Note Linux in the mission statement
- Update the maintainer guidelines based on current state
- Loosen the new maintainer expectations
- Clarify what things the PLC should be added to
- Add documentation for making a new Homebrew release
2019-02-13 15:02:18 +00:00
Shaun Jackman
f25eff15a6 Add docs/Linuxbrew.md 2019-01-06 10:54:39 -08:00
Andrew Janke
36e961ad98 Doco: add a Shell Completion doc
This describes how to configure your shell to use Homebrew-managed completion
definitions. Needed because this is a manual step the user has to do.
2018-05-22 08:11:31 -04: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
b70b5429d0 Deprecate default_formula Requirement DSL
This has been a nightmare in terms of the complexity to our dependency
system and the whack-a-mole required on bugs. If a Requirement resolves
to a Formula it should just use `depends_on "formula"` instead. This
matches the effective behaviour all users of bottles (the vast majority
of users and installs) and what we're doing in Homebrew/homebrew-core.
2018-01-14 13:27:43 +00:00
EricFromCanada
f34f4e80f8 docs: rename Taps docs to match convention 2017-11-17 16:40:37 -05:00
bm5k
c5e350ae18 fix link to Interesting-Taps-and-Forks.md 2017-07-11 23:36:49 -05:00
Mike McQuaid
650c33e73b man: generate Markdown man page.
The existing `brew.1.html` wasn't particularly pleasant to read and
given everything else in `docs/` is a Markdown file it makes sense to
generate a post-processed Markdown file that can in turn be used by
Jekyll to generate a nicely themed HTML file.
2017-03-22 21:38:41 +00:00