docs: updated broken links (#951)

Fixes: #948
Signed-off-by: Xiaoxuan Wang <[email protected]>

Author: wangxiaoxuan273

registry/registry.go

@@ -31,7 +31,7 @@ type Registry interface {
 	// Note: When implemented by a remote registry, the catalog API is called.
 	// However, not all registries supports pagination or conforms the
 	// specification.
-	// Reference: https://docs.docker.com/registry/spec/api/#catalog
+	// Reference: https://distribution.github.io/distribution/spec/api/#catalog
 	// See also `Repositories()` in this package.
 	Repositories(ctx context.Context, last string, fn func(repos []string) error) error
 

registry/remote/auth/challenge.go

@@ -62,7 +62,7 @@ func (s Scheme) String() string {
 // parseChallenge parses the "WWW-Authenticate" header returned by the remote
 // registry, and extracts parameters if scheme is Bearer.
 // References:
-// - https://docs.docker.com/registry/spec/auth/token/#how-to-authenticate
+// - https://distribution.github.io/distribution/spec/auth/token/#how-to-authenticate
 // - https://tools.ietf.org/html/rfc7235#section-2.1
 func parseChallenge(header string) (scheme Scheme, params map[string]string) {
 	// as defined in RFC 7235 section 2.1, we have

registry/remote/auth/client.go

@@ -51,7 +51,7 @@ var DefaultClient = &Client{
 // limit, which is usually 16 KiB. As specified by the distribution, the
 // response may contain 2 identical tokens, that is, 16 x 2 = 32 KiB.
 // Hence, 128 KiB should be sufficient.
-// References: https://docs.docker.com/registry/spec/auth/token/
+// References: https://distribution.github.io/distribution/spec/auth/token/
 var maxResponseBytes int64 = 128 * 1024 // 128 KiB
 
 // defaultClientID specifies the default client ID used in OAuth2.
@@ -110,15 +110,15 @@ type Client struct {
 
 	// ClientID used in fetching OAuth2 token as a required field.
 	// If empty, a default client ID is used.
-	// Reference: https://docs.docker.com/registry/spec/auth/oauth/#getting-a-token
+	// Reference: https://distribution.github.io/distribution/spec/auth/oauth/#getting-a-token
 	ClientID string
 
 	// ForceAttemptOAuth2 controls whether to follow OAuth2 with password grant
 	// instead the distribution spec when authenticating using username and
 	// password.
 	// References:
-	// - https://docs.docker.com/registry/spec/auth/jwt/
-	// - https://docs.docker.com/registry/spec/auth/oauth/
+	// - https://distribution.github.io/distribution/spec/auth/jwt/
+	// - https://distribution.github.io/distribution/spec/auth/oauth/
 	ForceAttemptOAuth2 bool
 }
 
@@ -312,8 +312,8 @@ func (c *Client) fetchBearerToken(ctx context.Context, registry, realm, service
 // specification.
 // It fetches anonymous tokens if no credential is provided.
 // References:
-// - https://docs.docker.com/registry/spec/auth/jwt/
-// - https://docs.docker.com/registry/spec/auth/token/
+// - https://distribution.github.io/distribution/spec/auth/jwt/
+// - https://distribution.github.io/distribution/spec/auth/token/
 func (c *Client) fetchDistributionToken(ctx context.Context, realm, service string, scopes []string, username, password string) (string, error) {
 	req, err := http.NewRequestWithContext(ctx, http.MethodGet, realm, nil)
 	if err != nil {
@@ -340,7 +340,7 @@ func (c *Client) fetchDistributionToken(ctx context.Context, realm, service stri
 		return "", errutil.ParseErrorResponse(resp)
 	}
 
-	// As specified in https://docs.docker.com/registry/spec/auth/token/ section
+	// As specified in https://distribution.github.io/distribution/spec/auth/token/ section
 	// "Token Response Fields", the token is either in `token` or
 	// `access_token`. If both present, they are identical.
 	var result struct {
@@ -361,7 +361,7 @@ func (c *Client) fetchDistributionToken(ctx context.Context, realm, service stri
 }
 
 // fetchOAuth2Token fetches an OAuth2 access token.
-// Reference: https://docs.docker.com/registry/spec/auth/oauth/
+// Reference: https://distribution.github.io/distribution/spec/auth/oauth/
 func (c *Client) fetchOAuth2Token(ctx context.Context, realm, service string, scopes []string, cred Credential) (string, error) {
 	form := url.Values{}
 	if cred.RefreshToken != "" {

registry/remote/auth/credential.go

@@ -30,11 +30,11 @@ type Credential struct {
 	// RefreshToken is a bearer token to be sent to the authorization service
 	// for fetching access tokens.
 	// A refresh token is often referred as an identity token.
-	// Reference: https://docs.docker.com/registry/spec/auth/oauth/
+	// Reference: https://distribution.github.io/distribution/spec/auth/oauth/
 	RefreshToken string
 
 	// AccessToken is a bearer token to be sent to the registry.
 	// An access token is often referred as a registry token.
-	// Reference: https://docs.docker.com/registry/spec/auth/token/
+	// Reference: https://distribution.github.io/distribution/spec/auth/token/
 	AccessToken string
 }

registry/remote/auth/example_test.go

@@ -199,7 +199,7 @@ func ExampleClient_Do_clientConfigurations() {
 	client.SetUserAgent("example user agent")
 	// Tokens carry restrictions about what resources they can access and how.
 	// Such restrictions are represented and enforced as Scopes.
-	// Reference: https://docs.docker.com/registry/spec/auth/scope/
+	// Reference: https://distribution.github.io/distribution/spec/auth/scope/
 	scopes := []string{
 		"repository:dst:pull,push",
 		"repository:src:pull",

registry/remote/auth/scope.go

@@ -24,7 +24,7 @@ import (
 )
 
 // Actions used in scopes.
-// Reference: https://docs.docker.com/registry/spec/auth/scope/
+// Reference: https://distribution.github.io/distribution/spec/auth/scope/
 const (
 	// ActionPull represents generic read access for resources of the repository
 	// type.
@@ -43,7 +43,7 @@ const (
 const ScopeRegistryCatalog = "registry:catalog:*"
 
 // ScopeRepository returns a repository scope with given actions.
-// Reference: https://docs.docker.com/registry/spec/auth/scope/
+// Reference: https://distribution.github.io/distribution/spec/auth/scope/
 func ScopeRepository(repository string, actions ...string) string {
 	actions = cleanActions(actions)
 	if repository == "" || len(actions) == 0 {
@@ -98,7 +98,7 @@ type scopesContextKey struct{}
 // Passing an empty list of scopes will virtually remove the scope hints in the
 // context.
 //
-// Reference: https://docs.docker.com/registry/spec/auth/scope/
+// Reference: https://distribution.github.io/distribution/spec/auth/scope/
 func WithScopes(ctx context.Context, scopes ...string) context.Context {
 	scopes = CleanScopes(scopes)
 	return context.WithValue(ctx, scopesContextKey{}, scopes)
@@ -143,7 +143,7 @@ type scopesForHostContextKey string
 // Passing an empty list of scopes will virtually remove the scope hints in the
 // context for the given host.
 //
-// Reference: https://docs.docker.com/registry/spec/auth/scope/
+// Reference: https://distribution.github.io/distribution/spec/auth/scope/
 func WithScopesForHost(ctx context.Context, host string, scopes ...string) context.Context {
 	scopes = CleanScopes(scopes)
 	return context.WithValue(ctx, scopesForHostContextKey(host), scopes)

registry/remote/errcode/errors.go

@@ -25,7 +25,7 @@ import (
 
 // References:
 //   - https://github.com/opencontainers/distribution-spec/blob/v1.1.1/spec.md#error-codes
-//   - https://docs.docker.com/registry/spec/api/#errors-2
+//   - https://distribution.github.io/distribution/spec/api/#errors-2
 const (
 	ErrorCodeBlobUnknown         = "BLOB_UNKNOWN"
 	ErrorCodeBlobUploadInvalid   = "BLOB_UPLOAD_INVALID"
@@ -46,7 +46,7 @@ const (
 // registry.
 // References:
 //   - https://github.com/opencontainers/distribution-spec/blob/v1.1.1/spec.md#error-codes
-//   - https://docs.docker.com/registry/spec/api/#errors-2
+//   - https://distribution.github.io/distribution/spec/api/#errors-2
 type Error struct {
 	Code    string `json:"code"`
 	Message string `json:"message"`
@@ -74,7 +74,7 @@ func (e Error) Error() string {
 // server.
 // References:
 //   - https://github.com/opencontainers/distribution-spec/blob/v1.1.1/spec.md#error-codes
-//   - https://docs.docker.com/registry/spec/api/#errors-2
+//   - https://distribution.github.io/distribution/spec/api/#errors-2
 type Errors []Error
 
 // Error returns a error string describing the error.

registry/remote/registry.go

@@ -43,7 +43,7 @@ type Registry struct {
 	// RepositoryListPageSize specifies the page size when invoking the catalog
 	// API.
 	// If zero, the page size is determined by the remote registry.
-	// Reference: https://docs.docker.com/registry/spec/api/#catalog
+	// Reference: https://distribution.github.io/distribution/spec/api/#catalog
 	RepositoryListPageSize int
 }
 
@@ -93,7 +93,7 @@ func (r *Registry) do(req *http.Request) (*http.Response, error) {
 // Ping can be used to check authentication when an auth client is configured.
 //
 // References:
-//   - https://docs.docker.com/registry/spec/api/#base
+//   - https://distribution.github.io/distribution/spec/api/#base
 //   - https://github.com/opencontainers/distribution-spec/blob/v1.1.1/spec.md#api
 func (r *Registry) Ping(ctx context.Context) error {
 	url := buildRegistryBaseURL(r.PlainHTTP, r.Reference)
@@ -125,7 +125,7 @@ func (r *Registry) Ping(ctx context.Context) error {
 // repo specified by `last`. Otherwise, the response starts from the top
 // of the Repositories list.
 //
-// Reference: https://docs.docker.com/registry/spec/api/#catalog
+// Reference: https://distribution.github.io/distribution/spec/api/#catalog
 func (r *Registry) Repositories(ctx context.Context, last string, fn func(repos []string) error) error {
 	ctx = auth.AppendScopesForHost(ctx, r.Reference.Host(), auth.ScopeRegistryCatalog)
 	url := buildRegistryCatalogURL(r.PlainHTTP, r.Reference)

registry/remote/repository.go

@@ -52,7 +52,7 @@ const (
 	// uploaded blob.
 	//
 	// References:
-	//   - https://docs.docker.com/registry/spec/api/#digest-header
+	//   - https://distribution.github.io/distribution/spec/api/#digest-header
 	//   - https://github.com/opencontainers/distribution-spec/blob/v1.1.1/spec.md#pull
 	headerDockerContentDigest = "Docker-Content-Digest"
 
@@ -112,7 +112,7 @@ type Repository struct {
 
 	// TagListPageSize specifies the page size when invoking the tag list API.
 	// If zero, the page size is determined by the remote registry.
-	// Reference: https://docs.docker.com/registry/spec/api/#tags
+	// Reference: https://distribution.github.io/distribution/spec/api/#tags
 	TagListPageSize int
 
 	// ReferrerListPageSize specifies the page size when invoking the Referrers
@@ -394,7 +394,7 @@ func (r *Repository) ParseReference(reference string) (registry.Reference, error
 //
 // References:
 //   - https://github.com/opencontainers/distribution-spec/blob/v1.1.1/spec.md#content-discovery
-//   - https://docs.docker.com/registry/spec/api/#tags
+//   - https://distribution.github.io/distribution/spec/api/#tags
 func (r *Repository) Tags(ctx context.Context, last string, fn func(tags []string) error) error {
 	ctx = auth.AppendRepositoryScope(ctx, r.Reference, auth.ActionPull)
 	url := buildRepositoryTagListURL(r.PlainHTTP, r.Reference)
@@ -758,7 +758,7 @@ func (s *blobStore) Fetch(ctx context.Context, target ocispec.Descriptor) (rc io
 		// check server range request capability.
 		// Docker spec allows range header form of "Range: bytes=<start>-<end>".
 		// However, the remote server may still not RFC 7233 compliant.
-		// Reference: https://docs.docker.com/registry/spec/api/#blob
+		// Reference: https://distribution.github.io/distribution/spec/api/#blob
 		if rangeUnit := resp.Header.Get("Accept-Ranges"); rangeUnit == "bytes" {
 			return httputil.NewReadSeekCloser(s.repo.client(), req, resp.Body, target.Size), nil
 		}
@@ -845,8 +845,8 @@ func (s *blobStore) sibling(otherRepoName string) *blobStore {
 // authentication errors.
 //
 // References:
-//   - https://docs.docker.com/registry/spec/api/#pushing-an-image
-//   - https://docs.docker.com/registry/spec/api/#initiate-blob-upload
+//   - https://distribution.github.io/distribution/spec/api/#pushing-an-image
+//   - https://distribution.github.io/distribution/spec/api/#initiate-blob-upload
 //   - https://github.com/opencontainers/distribution-spec/blob/v1.1.1/spec.md#pushing-a-blob-monolithically
 func (s *blobStore) Push(ctx context.Context, expected ocispec.Descriptor, content io.Reader) error {
 	// start an upload
@@ -1019,7 +1019,7 @@ func (s *blobStore) FetchReference(ctx context.Context, reference string) (desc
 		// check server range request capability.
 		// Docker spec allows range header form of "Range: bytes=<start>-<end>".
 		// However, the remote server may still not RFC 7233 compliant.
-		// Reference: https://docs.docker.com/registry/spec/api/#blob
+		// Reference: https://distribution.github.io/distribution/spec/api/#blob
 		if rangeUnit := resp.Header.Get("Accept-Ranges"); rangeUnit == "bytes" {
 			return desc, httputil.NewReadSeekCloser(s.repo.client(), req, resp.Body, desc.Size), nil
 		}

registry/remote/url.go

@@ -34,14 +34,14 @@ func buildScheme(plainHTTP bool) string {
 
 // buildRegistryBaseURL builds the URL for accessing the base API.
 // Format: <scheme>://<registry>/v2/
-// Reference: https://docs.docker.com/registry/spec/api/#base
+// Reference: https://distribution.github.io/distribution/spec/api/#base
 func buildRegistryBaseURL(plainHTTP bool, ref registry.Reference) string {
 	return fmt.Sprintf("%s://%s/v2/", buildScheme(plainHTTP), ref.Host())
 }
 
 // buildRegistryCatalogURL builds the URL for accessing the catalog API.
 // Format: <scheme>://<registry>/v2/_catalog
-// Reference: https://docs.docker.com/registry/spec/api/#catalog
+// Reference: https://distribution.github.io/distribution/spec/api/#catalog
 func buildRegistryCatalogURL(plainHTTP bool, ref registry.Reference) string {
 	return fmt.Sprintf("%s://%s/v2/_catalog", buildScheme(plainHTTP), ref.Host())
 }
@@ -54,14 +54,14 @@ func buildRepositoryBaseURL(plainHTTP bool, ref registry.Reference) string {
 
 // buildRepositoryTagListURL builds the URL for accessing the tag list API.
 // Format: <scheme>://<registry>/v2/<repository>/tags/list
-// Reference: https://docs.docker.com/registry/spec/api/#tags
+// Reference: https://distribution.github.io/distribution/spec/api/#tags
 func buildRepositoryTagListURL(plainHTTP bool, ref registry.Reference) string {
 	return buildRepositoryBaseURL(plainHTTP, ref) + "/tags/list"
 }
 
 // buildRepositoryManifestURL builds the URL for accessing the manifest API.
 // Format: <scheme>://<registry>/v2/<repository>/manifests/<digest_or_tag>
-// Reference: https://docs.docker.com/registry/spec/api/#manifest
+// Reference: https://distribution.github.io/distribution/spec/api/#manifest
 func buildRepositoryManifestURL(plainHTTP bool, ref registry.Reference) string {
 	return strings.Join([]string{
 		buildRepositoryBaseURL(plainHTTP, ref),
@@ -72,7 +72,7 @@ func buildRepositoryManifestURL(plainHTTP bool, ref registry.Reference) string {
 
 // buildRepositoryBlobURL builds the URL for accessing the blob API.
 // Format: <scheme>://<registry>/v2/<repository>/blobs/<digest>
-// Reference: https://docs.docker.com/registry/spec/api/#blob
+// Reference: https://distribution.github.io/distribution/spec/api/#blob
 func buildRepositoryBlobURL(plainHTTP bool, ref registry.Reference) string {
 	return strings.Join([]string{
 		buildRepositoryBaseURL(plainHTTP, ref),
@@ -83,14 +83,14 @@ func buildRepositoryBlobURL(plainHTTP bool, ref registry.Reference) string {
 
 // buildRepositoryBlobUploadURL builds the URL for blob uploading.
 // Format: <scheme>://<registry>/v2/<repository>/blobs/uploads/
-// Reference: https://docs.docker.com/registry/spec/api/#initiate-blob-upload
+// Reference: https://distribution.github.io/distribution/spec/api/#initiate-blob-upload
 func buildRepositoryBlobUploadURL(plainHTTP bool, ref registry.Reference) string {
 	return buildRepositoryBaseURL(plainHTTP, ref) + "/blobs/uploads/"
 }
 
 // buildRepositoryBlobMountURLbuilds the URL for cross-repository mounting.
 // Format: <scheme>://<registry>/v2/<repository>/blobs/uploads/?mount=<digest>&from=<other_repository>
-// Reference: https://docs.docker.com/registry/spec/api/#blob
+// Reference: https://distribution.github.io/distribution/spec/api/#blob
 func buildRepositoryBlobMountURL(plainHTTP bool, ref registry.Reference, d digest.Digest, fromRepo string) string {
 	return fmt.Sprintf("%s?mount=%s&from=%s",
 		buildRepositoryBlobUploadURL(plainHTTP, ref),