Skip to content

Commit

Permalink
Shorten docs.brew.sh links.
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcQuaid committed Feb 23, 2018
1 parent 17aad3b commit 3978821
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c

* run `brew update` (twice)
* run and read `brew doctor`
* read [the Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting.html)
* read [the Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting)
* open an issue on the formula's repository

### Submit a version upgrade for the `foo` formula
Expand All @@ -16,18 +16,18 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c

### Add a new formula for `foo` version `2.3.4` from `$URL`

* read [the Formula Cookbook](https://docs.brew.sh/Formula-Cookbook.html) or: `brew create $URL` and make edits
* read [the Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) or: `brew create $URL` and make edits
* `brew install --build-from-source foo`
* `brew audit --new-formula foo`
* `git commit` with message formatted `foo 2.3.4 (new formula)`
* [open a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request.html) and fix any failing tests
* [open a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request) and fix any failing tests

### Contribute a fix to the `foo` formula

* `brew edit foo` and make edits
* leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#bottle-class_method) as-is
* `brew uninstall --force foo`, `brew install --build-from-source foo`, `brew test foo`, and `brew audit --strict foo`
* `git commit` with message formatted `foo: fix <insert details>`
* [open a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request.html) and fix any failing tests
* [open a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request) and fix any failing tests

Thanks!
2 changes: 1 addition & 1 deletion Formula/postgresql@9.4.rb
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def caveats
ARCHFLAGS="-arch x86_64" gem install pg
To install gems without sudo, see the Homebrew documentation:
https://github.com/Homebrew/brew/blob/master/docs/Gems%2C-Eggs-and-Perl-Modules.md
https://docs.brew.sh/Gems,-Eggs-and-Perl-Modules
EOS
end

Expand Down
2 changes: 1 addition & 1 deletion Formula/pypy.rb
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ def caveats; <<~EOS
To update setuptools and pip between pypy releases, run:
pip_pypy install --upgrade pip setuptools
See: https://docs.brew.sh/Homebrew-and-Python.html
See: https://docs.brew.sh/Homebrew-and-Python
EOS
end

Expand Down
2 changes: 1 addition & 1 deletion Formula/pypy3.rb
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ def caveats; <<~EOS
To update pip and setuptools between pypy3 releases, run:
pip_pypy3 install --upgrade pip setuptools
See: https://docs.brew.sh/Homebrew-and-Python.html
See: https://docs.brew.sh/Homebrew-and-Python
EOS
end

Expand Down
4 changes: 2 additions & 2 deletions Formula/python.rb
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ def sitecustomize
<<~EOS
# This file is created by Homebrew and is executed on each python startup.
# Don't print from here, or else python command line scripts may fail!
# <https://docs.brew.sh/Homebrew-and-Python.html>
# <https://docs.brew.sh/Homebrew-and-Python>
import re
import os
import sys
Expand Down Expand Up @@ -374,7 +374,7 @@ def caveats; <<~EOS
They will install into the site-package directory
#{site_packages}
See: https://docs.brew.sh/Homebrew-and-Python.html
See: https://docs.brew.sh/Homebrew-and-Python
EOS
end

Expand Down
4 changes: 2 additions & 2 deletions Formula/python3.rb
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ def sitecustomize
<<~EOS
# This file is created by Homebrew and is executed on each python startup.
# Don't print from here, or else python command line scripts may fail!
# <https://docs.brew.sh/Homebrew-and-Python.html>
# <https://docs.brew.sh/Homebrew-and-Python>
import re
import os
import sys
Expand Down Expand Up @@ -340,7 +340,7 @@ def caveats
They will install into the site-package directory
#{HOMEBREW_PREFIX/"lib/python#{xy}/site-packages"}
See: https://docs.brew.sh/Homebrew-and-Python.html
See: https://docs.brew.sh/Homebrew-and-Python
EOS

# Tk warning only for 10.6
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Just `brew install <formula>`. This is the default tap for Homebrew and is insta
## Troubleshooting
First, please run `brew update` and `brew doctor`.

Second, read the [Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting.html).
Second, read the [Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting).

**If you don't read these it will take us far longer to help you with your problem.**

Expand Down

0 comments on commit 3978821

Please sign in to comment.