From 8bf0cee70ec8e51356bd054b97d91dc1151a4de1 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Sun, 28 May 2023 10:36:37 +0200 Subject: [PATCH] docs: replace godoc.org references --- README.md | 2 +- cmd/zz_gen_cmd_dnshelp.go | 1 + docs/content/dns/zz_gen_designate.md | 2 +- docs/content/dns/zz_gen_route53.md | 1 + docs/content/usage/library/_index.md | 2 +- docs/data/zz_cli_help.toml | 3 +++ providers/dns/designate/designate.toml | 2 +- 7 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5fd7472..ab258549 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Let's Encrypt client and ACME library written in Go. -[![GoDoc](https://godoc.org/github.com/go-acme/lego?status.svg)](https://pkg.go.dev/mod/github.com/go-acme/lego/v4) +[![Go Reference](https://pkg.go.dev/badge/github.com/go-acme/lego/v4.svg)](https://pkg.go.dev/github.com/go-acme/lego/v4) [![Build Status](https://github.com//go-acme/lego/workflows/Main/badge.svg?branch=master)](https://github.com//go-acme/lego/actions) [![Docker Pulls](https://img.shields.io/docker/pulls/goacme/lego.svg)](https://hub.docker.com/r/goacme/lego/) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index ce14fc78..5c0b966d 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -2076,6 +2076,7 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln(`Credentials:`) ew.writeln(` - "AWS_ACCESS_KEY_ID": Managed by the AWS client. Access key ID ('AWS_ACCESS_KEY_ID_FILE' is not supported, use 'AWS_SHARED_CREDENTIALS_FILE' instead)`) ew.writeln(` - "AWS_ASSUME_ROLE_ARN": Managed by the AWS Role ARN ('AWS_ASSUME_ROLE_ARN_FILE' is not supported)`) + ew.writeln(` - "AWS_EXTERNAL_ID": Managed by STS AssumeRole API operation ('AWS_EXTERNAL_ID_FILE' is not supported)`) ew.writeln(` - "AWS_HOSTED_ZONE_ID": Override the hosted zone ID.`) ew.writeln(` - "AWS_PROFILE": Managed by the AWS client ('AWS_PROFILE_FILE' is not supported)`) ew.writeln(` - "AWS_REGION": Managed by the AWS client ('AWS_REGION_FILE' is not supported)`) diff --git a/docs/content/dns/zz_gen_designate.md b/docs/content/dns/zz_gen_designate.md index d1254ec8..1614b689 100644 --- a/docs/content/dns/zz_gen_designate.md +++ b/docs/content/dns/zz_gen_designate.md @@ -103,7 +103,7 @@ For more information, you can read about the different methods of authentication ## More information - [API documentation](https://docs.openstack.org/designate/latest/) -- [Go client](https://godoc.org/github.com/gophercloud/gophercloud/openstack/dns/v2) +- [Go client](https://pkg.go.dev/github.com/gophercloud/gophercloud/openstack/dns/v2) diff --git a/docs/content/dns/zz_gen_route53.md b/docs/content/dns/zz_gen_route53.md index a6a504b9..fcc7c242 100644 --- a/docs/content/dns/zz_gen_route53.md +++ b/docs/content/dns/zz_gen_route53.md @@ -42,6 +42,7 @@ AWS_HOSTED_ZONE_ID=your_hosted_zone_id \ |-----------------------|-------------| | `AWS_ACCESS_KEY_ID` | Managed by the AWS client. Access key ID (`AWS_ACCESS_KEY_ID_FILE` is not supported, use `AWS_SHARED_CREDENTIALS_FILE` instead) | | `AWS_ASSUME_ROLE_ARN` | Managed by the AWS Role ARN (`AWS_ASSUME_ROLE_ARN_FILE` is not supported) | +| `AWS_EXTERNAL_ID` | Managed by STS AssumeRole API operation (`AWS_EXTERNAL_ID_FILE` is not supported) | | `AWS_HOSTED_ZONE_ID` | Override the hosted zone ID. | | `AWS_PROFILE` | Managed by the AWS client (`AWS_PROFILE_FILE` is not supported) | | `AWS_REGION` | Managed by the AWS client (`AWS_REGION_FILE` is not supported) | diff --git a/docs/content/usage/library/_index.md b/docs/content/usage/library/_index.md index 60adf98d..5e1d062b 100644 --- a/docs/content/usage/library/_index.md +++ b/docs/content/usage/library/_index.md @@ -10,7 +10,7 @@ Lego can be use as a Go Library. ## GoDoc -The GoDoc can be found here: [GoDoc](https://pkg.go.dev/mod/github.com/go-acme/lego/v4). +The GoDoc can be found here: [Go Reference](https://pkg.go.dev/github.com/go-acme/lego/v4). ## Usage diff --git a/docs/data/zz_cli_help.toml b/docs/data/zz_cli_help.toml index fa77b68b..d99b3f3d 100644 --- a/docs/data/zz_cli_help.toml +++ b/docs/data/zz_cli_help.toml @@ -78,6 +78,9 @@ USAGE: OPTIONS: --always-deactivate-authorizations value Force the authorizations to be relinquished even if the certificate request was successful. + --ari-enable Use the renewalInfo endpoint (draft-ietf-acme-ari) to check if a certificate should be renewed. (default: false) + --ari-hash-name value The string representation of the hash expected by the renewalInfo endpoint (e.g. "SHA-256"). (default: "SHA-256") + --ari-wait-to-renew-duration value The maximum duration you're willing to sleep for a renewal time returned by the renewalInfo endpoint. (default: 0s) --days value The number of days left on a certificate to renew it. (default: 30) --must-staple Include the OCSP must staple TLS extension in the CSR and generated certificate. Only works if the CSR is generated by lego. (default: false) --no-bundle Do not create a certificate bundle by adding the issuers certificate to the new certificate. (default: false) diff --git a/providers/dns/designate/designate.toml b/providers/dns/designate/designate.toml index b8859997..045c2359 100644 --- a/providers/dns/designate/designate.toml +++ b/providers/dns/designate/designate.toml @@ -65,4 +65,4 @@ For more information, you can read about the different methods of authentication [Links] API = "https://docs.openstack.org/designate/latest/" - GoClient = "https://godoc.org/github.com/gophercloud/gophercloud/openstack/dns/v2" + GoClient = "https://pkg.go.dev/github.com/gophercloud/gophercloud/openstack/dns/v2"