31 Commits

Author SHA1 Message Date
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
Sam Ford
1c0e657edb
docs: update redirecting url
A php.net URL in `docs/Versions.md` is redirecting to www.php.net, so
this updates the URL to avoid the redirection.
2024-11-24 10:46:37 -05:00
Michael Cho
a548a81040
docs: remove references to deprecated/disabled GCC formulae 2024-09-02 12:03:06 -04:00
Mike McQuaid
63e1c540fd
Update Acceptable/Deprecating/Forks/Versions docs
As discussed at the AGM:
- Only allow formula/cask forks to be used when either blessed by
  the source or used by two other major distributions,
- Further elaborate and tweak reasons to deprecate/disable formulae.
- Allow more versioned formulae when widely used.
- Add a document (based on above) for deprecating/disabling casks.

While we're here:
- let VSCode Markdown linting remove the trailing `!` from an
  Acceptable Casks heading
2024-02-13 10:13:44 +00: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
Bo Anderson
323a180d26
Update docs/Versions.md
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2021-11-26 13:30:28 +00:00
Bo Anderson
2b9784864d
docs/Versions: require ABI stability 2021-11-26 13:05:08 +00:00
Sean Molenaar
88cf8681a3
docs: rename version claim to policy
Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2021-04-27 16:43:54 +02:00
Sean Molenaar
df04c2f9fa
docs: clarify upstream versions requirement 2021-04-27 16:36:39 +02:00
Adrian Ho
0e655d8528 docs/Versions: Cleanup and clarifications
* Removed all mentions of `homebrew/versions`, since it's dead and long gone.
* Version support requirement: Updated PHP example, and added contrasting example to address a common misconception
* Standardize on the use of "main" rather than "non-versioned" to avoid confusion
* Directly address the most common reason for (disallowed) versioning
2020-07-11 22:25:33 +10:00
Sean Molenaar
94df4a2e7b
Fix wording
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2020-05-27 12:36:37 +02:00
Sean Molenaar
a715e28360
Clarify what entails a versioned formula 2020-05-26 20:27:39 +02:00
Mike McQuaid
ff35b943d3
docs/Versions: tweak unstable language. 2020-03-02 13:06:59 +00:00
Lukas Bestle
943beaec1e
Versions docs: Add note on unstable versions 2020-03-01 11:32:48 +01:00
EricFromCanada
31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
Viktor Szakats
a0d971a0d0 secure/fix URLs 2018-10-03 21:21:05 +00: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
b5e4665fa1
versions: tweak extract wording. 2018-08-27 08:39:29 +01:00
Caleb Xu
6f1ffbb660
extract: update docs
Preliminary blurb in documentation about using brew extract to obtain deprecated/deleted/particular versions of formulae.
2018-08-26 16:43:01 -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
66410ccf1b Versions: additional formulae requirements.
These should help keep these formulae more maintainable.
2018-02-21 18:04:15 +00:00
Mike McQuaid
4514f7b17d docs/Versions: versions should build.
Seems obvious but was somehow omitted.
2018-01-19 16:50:49 +00:00
Mike McQuaid
1285a41640 Versions: update acceptable versioned formulae.
Clarify further what's acceptable and what isn't.
2018-01-19 16:38:10 +00: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
EricFromCanada
ca0071ffc9 Grammar fixes for docs
Fixes to spelling and punctuation for consistency and readability.
2017-02-23 12:20:07 -05:00
Mike McQuaid
dac66c4ada Add keg_only :versioned_formula.
This is used to indicate a formula is a version of another formula.
This will be used to provide a consistent interface for older formulae
versions and replaces the use of `conflicts_with`.
2017-01-17 10:50:04 +00:00
Jonathan Chang
9a6cd9b83f docs: fix titles on docs.brew.sh 2017-01-04 16:16:00 -06:00
Mike McQuaid
bc0aa4e64c Add versions documentation. 2017-01-03 18:01:03 +00:00