Skip to content

Commit

Permalink
Fix typos in the readmes and update examples
Browse files Browse the repository at this point in the history
A few minor improvements

Signed-off-by: Tim Smith <tsmith@chef.io>
  • Loading branch information
tas50 committed Feb 11, 2020
1 parent a8f3a6d commit 313476d
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ cd .delivery/build_cookbook
kitchen converge
```

This will take awhile because it will now pass on the first VM, and then create the second VM. We should have warned you this was a good time for a coffee break.
This will take a while because it will now pass on the first VM, and then create the second VM. We should have warned you this was a good time for a coffee break.

```
Recipe: test::default
Expand All @@ -115,7 +115,7 @@ Recipe: test::default
Running handlers:
Running handlers complete
Chef Infra Client finished, 3/32 resources updated in 54.665445968 seconds
Finished converging <default-centos-71> (1m26.83s).
Finished converging <default-centos-8> (1m26.83s).
```

Victory is ours! Our verify phase passed on the build nodes.
Expand All @@ -129,7 +129,7 @@ delivery review

## FAQ

### Why don't I just run rspec and foodcritic/cookstyle on my local system?
### Why don't I just run rspec and cookstyle on my local system?

An objection to the Test Kitchen approach is that it is much faster to run the unit, lint, and syntax commands for the project on the local system. That is totally true, and also totally valid. Do that for the really fast feedback loop. However, the dance we do with Test Kitchen brings a much higher degree of confidence in the changes we're making, that everything will run on the build nodes in Chef Workflow. We strongly encourage this approach before actually pushing the changes to Workflow.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Gemfile.lock
Policyfile.rb
Policyfile.lock.json

# Cookbooks #
# Documentation #
#############
CHANGELOG*
CONTRIBUTING*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This directory typically contains Chef cookbooks. This repository was
This directory typically contains Chef Infra cookbooks. This repository was
generated with the '--policy-only' option, which means you have chosen
to use a workflow where each cookbook is treated as an independent
software project. As a result, any cookbooks present in this directory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This directory contains the cookbooks used to configure systems in your infrastructure with Chef - an example basic cookbook called `example` has been automatically created for you.
This directory contains the cookbooks used to configure systems in your infrastructure with Chef Infra - an example basic cookbook called `example` has been automatically created for you.

Knife needs to be configured to know where the cookbooks are located with the `cookbook_path` setting. If this is not set, then several cookbook operations will fail to work properly.

Expand All @@ -23,7 +23,7 @@ cookbook_email "cookbooks@example.com"
cookbook_license "apachev2"
```

Supported values for `cookbook_license` are "apachev2", "mit","gplv2","gplv3", or "none". These settings are used to prefill comments in the default recipe, and the corresponding values in the metadata.rb. You are free to change the the comments in those files.
Supported values for `cookbook_license` are "apachev2", "mit","gplv2","gplv3", or "none". These settings are used to prefill comments in the default recipe, and the corresponding values in the metadata.rb. You are free to change the comments in those files.

Create new cookbooks in this directory with Chef.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ An example cookbook

## Requirements

### Platforms:
### Platforms

_No platforms defined_

### Cookbooks:
### Cookbooks

_No dependencies defined_

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ verifier:

platforms:
- name: ubuntu-18.04
- name: centos-7
- name: centos-8

suites:
- name: default
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ platforms:
intermediate_instructions:
- RUN /usr/bin/apt-get update

- name: centos-7
- name: centos-8
driver:
image: dokken/centos-7
image: dokken/centos-8
pid_one_command: /usr/lib/systemd/systemd

suites:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ verifier:

platforms:
- name: ubuntu-18.04
- name: centos-7
- name: centos-8

suites:
- name: default
Expand Down
4 changes: 2 additions & 2 deletions spec/unit/command/generator_commands/cookbook_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ def with_argv(argv)
platforms:
- name: ubuntu-18.04
- name: centos-7
- name: centos-8
suites:
- name: default
Expand Down Expand Up @@ -667,7 +667,7 @@ def with_argv(argv)
platforms:
- name: ubuntu-18.04
- name: centos-7
- name: centos-8
suites:
- name: default
Expand Down

0 comments on commit 313476d

Please sign in to comment.