Skip to content

Commit 46eef18

Browse files
committed
Documentation updates
Updates based on feedback: 1. Avoid making promises about future releases ... (so) avoid the word "yet." 2. We assume that users are reading the documentation while they use the product, so we write in the present tense. 3. Avoid the "Note" label because it doesn't tell users anything about the content of the note. Users can't tell whether the note will present crucial information or be just a tip. In this case, we could use the "Important" or "Restriction" label instead.
1 parent 267684a commit 46eef18

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

lib/puppet/application/filebucket.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ def help
7676
use your local file bucket by specifying '--local', or by specifying
7777
'--bucket' with a local path.
7878
79-
**Note**: Enabling and using the backup option, and by extension the
80-
filebucket resource, requires appropriate planning and management to ensure
81-
that sufficient disk space is available for the file backups. Generally, you
82-
can implement this using one of the following two options:
79+
**Important**: When you enable and use the backup option, and by extension
80+
the filebucket resource, you must ensure that sufficient disk space is
81+
available for the file backups. Generally, you can provide the disk space
82+
by using one of the following two options:
8383
8484
- Use a `find` command and `crontab` entry to retain only the last X days
8585
of file backups. For example:

lib/puppet/face/catalog.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
summary _("Retrieve the catalog for the node from which the command is run.")
3030
arguments "<certname>, <facts>"
3131
option("--facts_for_catalog") do
32-
summary _("Not yet implemented for the CLI; facts will be collected internally.")
32+
summary _("Not implemented for the CLI; facts are collected internally.")
3333
end
3434
returns <<-'EOT'
3535
A serialized catalog. When used from the Ruby API, returns a

0 commit comments

Comments
 (0)