From 526bf4775130d567de6b18fea8f3791d76c8be2a Mon Sep 17 00:00:00 2001 From: Jamie Edge Date: Sun, 16 Jan 2022 15:20:48 +0000 Subject: [PATCH] Replace godoc.org URLs (#342) * Replaced godoc.org URLs with equivalent pkg.go.dev URLs. * Switched to full package name for github.com/magefile/mage/mg. Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> --- README.md | 5 +++-- site/content/dependencies/_index.en.md | 4 ++-- site/content/filesources/_index.en.md | 2 +- site/content/libraries/_index.en.md | 6 +++--- site/content/zeroInstall/_index.en.md | 4 ++-- 5 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index eed068dc..d96fd025 100644 --- a/README.md +++ b/README.md @@ -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? diff --git a/site/content/dependencies/_index.en.md b/site/content/dependencies/_index.en.md index 857157be..92411111 100644 --- a/site/content/dependencies/_index.en.md +++ b/site/content/dependencies/_index.en.md @@ -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, diff --git a/site/content/filesources/_index.en.md b/site/content/filesources/_index.en.md index c2f2bd35..d427b7d9 100644 --- a/site/content/filesources/_index.en.md +++ b/site/content/filesources/_index.en.md @@ -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. diff --git a/site/content/libraries/_index.en.md b/site/content/libraries/_index.en.md index 6d8c8ed9..59a26822 100644 --- a/site/content/libraries/_index.en.md +++ b/site/content/libraries/_index.en.md @@ -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 diff --git a/site/content/zeroInstall/_index.en.md b/site/content/zeroInstall/_index.en.md index d239a047..8f71735c 100644 --- a/site/content/zeroInstall/_index.en.md +++ b/site/content/zeroInstall/_index.en.md @@ -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.