From f6bec6e017ed40aa7ba9c3a932d5f1c7868cc79b Mon Sep 17 00:00:00 2001 From: Sean Chittenden Date: Wed, 20 Apr 2016 18:13:58 -0400 Subject: [PATCH] Wordsmith the docs around the `list` command. Prompted by: feedback from conference attendees at PGConf '16 --- website/source/docs/concepts/policies.html.md | 6 +++--- website/source/docs/secrets/generic/index.html.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/website/source/docs/concepts/policies.html.md b/website/source/docs/concepts/policies.html.md index 9e1dfe0f3..eb1fe4657 100644 --- a/website/source/docs/concepts/policies.html.md +++ b/website/source/docs/concepts/policies.html.md @@ -65,9 +65,9 @@ over operations. The capabilities are: * `delete` - Delete the value at a path. - * `list` - List values at a path. Note that the keys returned by a `list` - operation are *not* filtered by policies. You should not store - sensitive/secret values in keys. + * `list` - List key names at a path. Note that the keys returned by a + `list` operation are *not* filtered by policies. Do not encode sensitive + information in key names. * `sudo` - Gain access to paths that are _root-protected_. This is _additive_ to other capabilities, so a path that requires `sudo` access will also diff --git a/website/source/docs/secrets/generic/index.html.md b/website/source/docs/secrets/generic/index.html.md index 38ddf5883..f9b09e9ea 100644 --- a/website/source/docs/secrets/generic/index.html.md +++ b/website/source/docs/secrets/generic/index.html.md @@ -107,11 +107,11 @@ seconds (one hour) as specified.
Description
- Returns a list of secret entries at the specified location. Folders are + Returns a list of key names at the specified location. Folders are suffixed with `/`. The input must be a folder; list on a file will not - return a value. Note that no policy-based filtering is performed on - returned keys; it is not recommended to put sensitive or secret values as - key names. The values themselves are not accessible via this command. + return a value. Note that no policy-based filtering is performed on keys; + do not encode sensitive information in key names. The values themselves + are not accessible via this command.
Method