32 Commits

Author SHA1 Message Date
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
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
Mike McQuaid
2aac904eac docs/README: link to Versions.md. 2017-01-07 13:02:16 +00: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
Nikolay Labinskiy
1758c2bcb5 readme update: it's version 1.0 already 2016-09-21 13:20:59 +03:00
Mike McQuaid
7a63a75360 Fix CONTRIBUTING.md references.
Closes #1040.
2016-09-20 11:51:08 +01:00
Mike McQuaid
bd6fb88ddc Rearrange repository files. 2016-09-20 10:41:42 +01:00