From 437d6a0408b9398d17acffb492ccaf2ddfa09100 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Mon, 6 May 2019 19:37:51 +0200 Subject: [PATCH] doc: remove TODO. (#878) --- cmd/zz_gen_cmd_dnshelp.go | 12 ++++++------ docs/content/dns/zz_gen_exec.md | 16 ++++++++-------- docs/content/dns/zz_gen_godaddy.md | 4 ++-- docs/content/dns/zz_gen_hostingde.md | 4 ++-- docs/content/dns/zz_gen_httpreq.md | 4 ++-- providers/dns/exec/exec.toml | 16 ++++++++-------- providers/dns/godaddy/godaddy.toml | 4 ++-- providers/dns/hostingde/hostingde.toml | 4 ++-- providers/dns/httpreq/httpreq.toml | 4 ++-- 9 files changed, 34 insertions(+), 34 deletions(-) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index bbd932fe..78ed0930 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -650,8 +650,8 @@ func displayDNSHelp(name string) { fmt.Fprintln(w) fmt.Fprintln(w, `Credentials:`) - fmt.Fprintln(w, ` - "GODADDY_API_KEY": **TODO**`) - fmt.Fprintln(w, ` - "GODADDY_API_SECRET": **TODO**`) + fmt.Fprintln(w, ` - "GODADDY_API_KEY": API key`) + fmt.Fprintln(w, ` - "GODADDY_API_SECRET": API secret`) fmt.Fprintln(w) fmt.Fprintln(w, `Additional Configuration:`) @@ -672,8 +672,8 @@ func displayDNSHelp(name string) { fmt.Fprintln(w) fmt.Fprintln(w, `Credentials:`) - fmt.Fprintln(w, ` - "HOSTINGDE_API_KEY": **TODO**`) - fmt.Fprintln(w, ` - "HOSTINGDE_ZONE_NAME": **TODO**`) + fmt.Fprintln(w, ` - "HOSTINGDE_API_KEY": API key`) + fmt.Fprintln(w, ` - "HOSTINGDE_ZONE_NAME": Zone name in ACE format`) fmt.Fprintln(w) fmt.Fprintln(w, `Additional Configuration:`) @@ -699,10 +699,10 @@ func displayDNSHelp(name string) { fmt.Fprintln(w, `Additional Configuration:`) fmt.Fprintln(w, ` - "HTTPREQ_HTTP_TIMEOUT": API request timeout`) - fmt.Fprintln(w, ` - "HTTPREQ_PASSWORD": **TODO**`) + fmt.Fprintln(w, ` - "HTTPREQ_PASSWORD": Basic authentication password`) fmt.Fprintln(w, ` - "HTTPREQ_POLLING_INTERVAL": Time between DNS propagation check`) fmt.Fprintln(w, ` - "HTTPREQ_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) - fmt.Fprintln(w, ` - "HTTPREQ_USERNAME": **TODO**`) + fmt.Fprintln(w, ` - "HTTPREQ_USERNAME": Basic authentication username`) fmt.Fprintln(w) fmt.Fprintln(w, `More information: https://go-acme.github.io/lego/dns/httpreq`) diff --git a/docs/content/dns/zz_gen_exec.md b/docs/content/dns/zz_gen_exec.md index 29a65bc0..a8938645 100644 --- a/docs/content/dns/zz_gen_exec.md +++ b/docs/content/dns/zz_gen_exec.md @@ -30,18 +30,18 @@ lego --dns exec --domains my.domain.com --email my@email.com run ## Base Configuration -| Environment Variable Name | Description | -|-----------------------|-------------| -| `EXEC_MODE` | `RAW`, none | -| `EXEC_PATH` | TODO | +| Environment Variable Name | Description | +|---------------------------|---------------------------------------| +| `EXEC_MODE` | `RAW`, none | +| `EXEC_PATH` | The path of the the external program. | ## Additional Configuration -| Environment Variable Name | Description | -|--------------------------------|-------------| -| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check | -| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | +| Environment Variable Name | Description | +|----------------------------|-------------------------------------------| +| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check. | +| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation. | ## Description diff --git a/docs/content/dns/zz_gen_godaddy.md b/docs/content/dns/zz_gen_godaddy.md index 16ea9299..a27f4ac4 100644 --- a/docs/content/dns/zz_gen_godaddy.md +++ b/docs/content/dns/zz_gen_godaddy.md @@ -29,8 +29,8 @@ _Please contribute by adding a CLI example._ | Environment Variable Name | Description | |-----------------------|-------------| -| `GODADDY_API_KEY` | **TODO** | -| `GODADDY_API_SECRET` | **TODO** | +| `GODADDY_API_KEY` | API key | +| `GODADDY_API_SECRET` | API secret | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here](/lego/dns/#configuration-and-credentials). diff --git a/docs/content/dns/zz_gen_hostingde.md b/docs/content/dns/zz_gen_hostingde.md index b3b00a3b..a2596dd8 100644 --- a/docs/content/dns/zz_gen_hostingde.md +++ b/docs/content/dns/zz_gen_hostingde.md @@ -29,8 +29,8 @@ _Please contribute by adding a CLI example._ | Environment Variable Name | Description | |-----------------------|-------------| -| `HOSTINGDE_API_KEY` | **TODO** | -| `HOSTINGDE_ZONE_NAME` | **TODO** | +| `HOSTINGDE_API_KEY` | API key | +| `HOSTINGDE_ZONE_NAME` | Zone name in ACE format | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here](/lego/dns/#configuration-and-credentials). diff --git a/docs/content/dns/zz_gen_httpreq.md b/docs/content/dns/zz_gen_httpreq.md index 8080047a..0896a439 100644 --- a/docs/content/dns/zz_gen_httpreq.md +++ b/docs/content/dns/zz_gen_httpreq.md @@ -44,10 +44,10 @@ More information [here](/lego/dns/#configuration-and-credentials). | Environment Variable Name | Description | |--------------------------------|-------------| | `HTTPREQ_HTTP_TIMEOUT` | API request timeout | -| `HTTPREQ_PASSWORD` | **TODO** | +| `HTTPREQ_PASSWORD` | Basic authentication password | | `HTTPREQ_POLLING_INTERVAL` | Time between DNS propagation check | | `HTTPREQ_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | -| `HTTPREQ_USERNAME` | **TODO** | +| `HTTPREQ_USERNAME` | Basic authentication username | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here](/lego/dns/#configuration-and-credentials). diff --git a/providers/dns/exec/exec.toml b/providers/dns/exec/exec.toml index 5c004a02..615c55d9 100644 --- a/providers/dns/exec/exec.toml +++ b/providers/dns/exec/exec.toml @@ -13,18 +13,18 @@ Additional = ''' ## Base Configuration -| Environment Variable Name | Description | -|-----------------------|-------------| -| `EXEC_MODE` | `RAW`, none | -| `EXEC_PATH` | TODO | +| Environment Variable Name | Description | +|---------------------------|---------------------------------------| +| `EXEC_MODE` | `RAW`, none | +| `EXEC_PATH` | The path of the the external program. | ## Additional Configuration -| Environment Variable Name | Description | -|--------------------------------|-------------| -| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check | -| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | +| Environment Variable Name | Description | +|----------------------------|-------------------------------------------| +| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check. | +| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation. | ## Description diff --git a/providers/dns/godaddy/godaddy.toml b/providers/dns/godaddy/godaddy.toml index 011a6c03..eb4acb6e 100644 --- a/providers/dns/godaddy/godaddy.toml +++ b/providers/dns/godaddy/godaddy.toml @@ -6,8 +6,8 @@ Since = "v0.5.0" [Configuration] [Configuration.Credentials] - GODADDY_API_KEY = "**TODO**" - GODADDY_API_SECRET = "**TODO**" + GODADDY_API_KEY = "API key" + GODADDY_API_SECRET = "API secret" [Configuration.Additional] GODADDY_POLLING_INTERVAL = "Time between DNS propagation check" GODADDY_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" diff --git a/providers/dns/hostingde/hostingde.toml b/providers/dns/hostingde/hostingde.toml index 30e06860..f19c4941 100644 --- a/providers/dns/hostingde/hostingde.toml +++ b/providers/dns/hostingde/hostingde.toml @@ -6,8 +6,8 @@ Since = "v1.1.0" [Configuration] [Configuration.Credentials] - HOSTINGDE_API_KEY = "**TODO**" - HOSTINGDE_ZONE_NAME = "**TODO**" + HOSTINGDE_API_KEY = "API key" + HOSTINGDE_ZONE_NAME = "Zone name in ACE format" [Configuration.Additional] HOSTINGDE_POLLING_INTERVAL = "Time between DNS propagation check" HOSTINGDE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" diff --git a/providers/dns/httpreq/httpreq.toml b/providers/dns/httpreq/httpreq.toml index b46df222..64750678 100644 --- a/providers/dns/httpreq/httpreq.toml +++ b/providers/dns/httpreq/httpreq.toml @@ -54,8 +54,8 @@ Basic authentication (optional) can be set with some environment variables: HTTPREQ_MODE = "`RAW`, none" HTTPREQ_ENDPOINT = "The URL of the server" [Configuration.Additional] - HTTPREQ_USERNAME = "**TODO**" - HTTPREQ_PASSWORD = "**TODO**" + HTTPREQ_USERNAME = "Basic authentication username" + HTTPREQ_PASSWORD = "Basic authentication password" HTTPREQ_POLLING_INTERVAL = "Time between DNS propagation check" HTTPREQ_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" HTTPREQ_HTTP_TIMEOUT = "API request timeout"