Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace godoc.org URLs #342

Merged
merged 4 commits into from
Jan 16, 2022
Merged

Replace godoc.org URLs #342

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbd8c36
Replaced godoc.org URLs with equivalent pkg.go.dev URLs.
JamieEdge Apr 5, 2021
c3e7d7e
Switched to full package name for github.com/magefile/mage/mg.
JamieEdge Oct 23, 2021
34095e0
Merge branch 'master' into replace-godoc-urls
JamieEdge Oct 25, 2021
f0a540a
Merge branch 'master' into replace-godoc-urls
JamieEdge Dec 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,10 @@ for discussion of usage, development, etc.

# Documentation

see [magefile.org](https://magefile.org) for full docs
See [magefile.org](https://magefile.org) for full documentation.

see [godoc.org/github.com/magefile/mage/mage](https://godoc.org/github.com/magefile/mage/mage) for how to use mage as a library.
See [pkg.go.dev/github.com/magefile/mage/mage](https://pkg.go.dev/github.com/magefile/mage/mage)
for instructions on how to use Mage as a library.

# Why?

Expand Down
4 changes: 2 additions & 2 deletions site/content/dependencies/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ weight = 30
+++

Mage supports a makefile-style tree of dependencies using the helper library
[github.com/magefile/mage/mg](https://godoc.org/github.com/magefile/mage/mg). To
declare dependencies, pass any number of dependent functions to mg.Deps.
[github.com/magefile/mage/mg](https://pkg.go.dev/github.com/magefile/mage/mg). To declare dependencies,
pass any number of dependent functions to mg.Deps.

A dependent function may be any function that has an optional first argument of context.Context, has
either no return or just an error return, and where the other arguments are all of type string, int,
Expand Down
2 changes: 1 addition & 1 deletion site/content/filesources/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight = 35
+++

Mage supports make-like comparisons of file sources and file targets. Using the
[target](https://godoc.org/github.com/magefile/mage/target) library, you can
[target](https://pkg.go.dev/github.com/magefile/mage/target) library, you can
easily compare the last modified times of a target file or directory with the
last modified time of the file or directories required to build that target.

Expand Down
6 changes: 3 additions & 3 deletions site/content/libraries/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ weight = 45
+++

There are three helper libraries bundled with mage,
[mg](https://godoc.org/github.com/magefile/mage/mg),
[sh](https://godoc.org/github.com/magefile/mage/sh), and
[target](https://godoc.org/github.com/magefile/mage/target)
[mg](https://pkg.go.dev/github.com/magefile/mage/mg),
[sh](https://pkg.go.dev/github.com/magefile/mage/sh) and
[target](https://pkg.go.dev/github.com/magefile/mage/target).

Package `mg` contains mage-specific helpers, such as Deps for declaring
dependent functions, and functions for returning errors with specific error
Expand Down
4 changes: 2 additions & 2 deletions site/content/zeroInstall/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ required = ["github.com/magefile/mage/mage"]

## Use Mage as a library

All of mage's functionality is accessible as a compile-in library. Checkout
[godoc.org/github.com/magefile/mage/mage](https://godoc.org/github.com/magefile/mage/mage)
All of mage's functionality is accessible as a compile-in library. Check out
[pkg.go.dev/github.com/magefile/mage/mage](https://pkg.go.dev/github.com/magefile/mage/mage)
for full details.

Fair warning, the API of mage/mage may change, so be sure to use vendoring.
Expand Down