Skip to content

Commit e7dd2e6

Browse files
Minor fixes in Workstation docs (#13) (#14)
(cherry picked from commit 41451f8) Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
1 parent cc3f8ec commit e7dd2e6

20 files changed

Lines changed: 69 additions & 69 deletions

content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Chef Workstation includes the following fully integrated tools:
3131

3232
- **Chef CLI (`chef-cli`)**: Primary command-line interface for Chef development workflows, providing unified access to common Chef operations
3333
- **Chef Infra Client**: Latest release candidate of the Chef Infra Client, enabling infrastructure automation and configuration management
34-
- **Knife**: Essential tool for interacting with Chef Infra Server, managing nodes, cookbooks, roles, and other Chef objects
34+
- **knife**: Essential tool for interacting with Chef Infra Server, managing nodes, cookbooks, roles, and other Chef objects
3535
- **Chef InSpec**: Latest release candidate of InSpec, enabling compliance and security testing.
3636

3737
### Testing and quality assurance

content/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ draft = false
1616

1717
Chef Workstation has the following requirements:
1818

19-
- Linux x86-64 (64-bit) systems only
19+
- Linux and Windows x86-64 (64-bit) systems only
2020
- Chef Habitat 1.6.0 or later installed
2121
- Minimum 2GB available disk space for installation
2222
- Internet connectivity for package downloads (or access to internal Habitat Builder)
@@ -178,7 +178,7 @@ The following table provides examples of common tool invocations using the Habit
178178
| Chef Vault | hab pkg exec chef/chef-vault chef-vault | chef-vault -v |
179179
| Fauxhai | hab pkg exec chef/fauxhai fauxhai | fauxhai -v |
180180
| Chef InSpec | hab pkg exec chef/inspec inspec | inspec version |
181-
| Knife | hab pkg exec chef/knife knife | knife -v |
181+
| knife | hab pkg exec chef/knife knife | knife -v |
182182

183183
## Install Chef Workstation tools
184184

content/license.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This page describes licensing requirements and how to configure a license for Ch
1414

1515
Different Chef Workstation components have different licensing requirements:
1616

17-
- **Knife 19**: Requires a license for bootstrapping Chef Infra Client 18 and earlier
17+
- **knife 19**: Requires a license for bootstrapping Chef Infra Client 18 and earlier
1818
- **Test Kitchen Enterprise**: Uses a license to execute tests but doesn't enforce licensing
1919

2020
## Get a license
@@ -28,7 +28,7 @@ For more information, see Chef's licensing documentation [Chef licensing documen
2828

2929
## Add a license to Workstation
3030

31-
If you've set a license for Chef Workstation, Test Kitchen Enterprise and Knife 19 automatically read and use it to execute tests or during bootstrap operations.
31+
If you've set a license for Chef Workstation, Test Kitchen Enterprise and knife 19 automatically read and use it to execute tests or during bootstrap operations.
3232

3333
You can apply a license to Chef Workstation in two ways:
3434

@@ -137,24 +137,24 @@ To display details of all licenses stored on disk:
137137
kitchen license list
138138
```
139139

140-
## Add a license to Knife
140+
## Add a license to knife
141141

142-
Knife requires a license for bootstrapping Chef Infra Client 18 and earlier.
142+
knife requires a license for bootstrapping Chef Infra Client 18 and earlier.
143143
Chef Infra Client 19 and above doesn't require a license because it's distributed through pre-signed URLs.
144144

145-
### How Knife uses licenses
145+
### How knife uses licenses
146146

147-
During bootstrap operations, Knife transfers the license to the target node and adds it as an argument to Chef Infra Client.
147+
During bootstrap operations, knife transfers the license to the target node and adds it as an argument to Chef Infra Client.
148148
Chef Infra Client validates the license and saves it on the provisioned node for future use.
149149

150150
### Add a license
151151

152-
Knife automatically reads a license that's configured locally for Chef Workstation through:
152+
knife automatically reads a license that's configured locally for Chef Workstation through:
153153

154154
- The `~/.chef/licenses.yml` file
155155
- The `CHEF_LICENSE_KEY` environment variable
156156

157-
You can also configure a license specifically for Knife with:
157+
You can also configure a license specifically for knife with:
158158

159159
- The `knife license` CLI command
160160
- The `--chef-license-key` command line option
@@ -173,9 +173,9 @@ To add a license using the `knife license` CLI:
173173

174174
1. Enter your license key at the second prompt.
175175

176-
Knife validates the license and saves it to disk.
176+
knife validates the license and saves it to disk.
177177

178-
##### Verify your Knife license
178+
##### Verify your knife license
179179

180180
To verify that a valid license is saved on disk:
181181

content/tools/chef_vault.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ knife[:vault_admins] = [ 'example-alice', 'example-bob', 'example-carol' ]
5252

5353
You can override these values in the command line by using `-A`.
5454

55-
## Knife Vault CLI
55+
## knife vault CLI
5656

5757
### Syntax
5858

@@ -699,7 +699,7 @@ A JSON file can be used in place of specifying the values on the command line, s
699699

700700
Sub-commands: `refresh`, `remove`, `rotate`
701701

702-
### Knife bootstrap options
702+
### knife bootstrap options
703703

704704
Use the following options with a validatorless bootstrap to specify items that are stored in Chef Vault:
705705

content/tools/ctl_chef.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ draft = false
1212
<!-- markdownlint-disable-file MD024 MD036-->
1313
<!-- vale chef.policyfile = NO -->
1414

15-
The chef executable is a command-line tool that does the following:
15+
The `chef` executable is a command-line tool that does the following:
1616

1717
- Generates repositories, cookbooks, recipes, attributes, templates, and custom resources.
1818
- Installs gems into the Chef development environment's Ruby installation.

content/tools/knife/_index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
+++
2-
title = "About Knife"
2+
title = "About knife"
33
draft = false
44

55
[menu]
66
[menu.tools]
7-
title = "About Knife"
8-
identifier = "tools/knife/knife.md About Knife"
7+
title = "About knife"
8+
identifier = "tools/knife/knife.md About knife"
99
parent = "tools/knife"
1010
weight = 10
1111
+++
@@ -22,23 +22,23 @@ chef-repo and Chef Infra Server. knife helps users to manage:
2222
- The installation of Chef Infra Client onto nodes
2323
- Searching of indexed data on Chef Infra Server
2424

25-
## Configure Knife
25+
## Configure knife
2626

27-
See the following guides to setup and configure Knife:
27+
See the following guides to setup and configure knife:
2828

29-
- **[Set up Knife](/tools/knife/knife_setup/)**: Configure knife to interact with your organization's Chef Infra Server and infrastructure.
30-
- **[Knife Common Options](/tools/knife/common_options/)**: Common options that are available for all knife subcommands.
29+
- **[Set up knife](/tools/knife/set_up/)**: Configure knife to interact with your organization's Chef Infra Server and infrastructure.
30+
- **[knife Common Options](/tools/knife/common_options/)**: Common options that are available for all knife subcommands.
3131
- **[config.rb](/tools/knife/config_rb/)**: Common options for the `config.rb` file
3232
- **[config.rb optional settings](tools/knife/config_rb_optional_settings/)**: Additional options for your `config.rb` file
3333

34-
## Knife subcommands
34+
## knife subcommands
3535

3636
knife includes a collection of built in subcommands that work together
3737
to provide the functionality required to take specific actions
3838
against any object in an organization, including cookbooks, nodes,
3939
roles, data bags, environments, and users.
4040

41-
### Knife command syntax
41+
### knife command syntax
4242

4343
All knife subcommands have the following syntax:
4444

@@ -161,16 +161,16 @@ to return:
161161
aardvarks/ anagrams/
162162
```
163163

164-
## Knife Plug-ins
164+
## knife Plug-ins
165165

166-
Knife functionality can be extended with plugins, which work the same as
167-
built-in subcommands (including common options). Knife plugins have been
166+
knife functionality can be extended with plugins, which work the same as
167+
built-in subcommands (including common options). knife plugins have been
168168
written to interact with common cloud providers, to simplify common Chef
169169
tasks, and to aid in Chef workflows.
170170

171171
### Plugin Installation
172172

173-
Knife plugins ship as RubyGems and are installed into the Chef
173+
knife plugins ship as RubyGems and are installed into the Chef
174174
Workstation installation using the `chef` command:
175175

176176
```bash
@@ -184,7 +184,7 @@ commands by running:
184184
knife rehash
185185
```
186186

187-
### Chef Maintained Knife Plugins
187+
### Chef Maintained knife Plugins
188188

189189
Chef maintains the following plugins which ship with Chef Workstation:
190190

@@ -200,6 +200,6 @@ Chef maintains the following plugins which ship with Chef Workstation:
200200
- `knife-vcenter`
201201
- `knife-windows`
202202

203-
### Community Knife Plugins
203+
### Community knife Plugins
204204

205-
Knife plugins written by Chef community members can be found on Supermarket under [Knife Plugins](https://supermarket.chef.io/tools?type=knife_plugin).
205+
knife plugins written by Chef community members can be found on Supermarket under [knife Plugins](https://supermarket.chef.io/tools?type=knife_plugin).

content/tools/knife/common_options.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
+++
2-
title = "Knife common options"
2+
title = "knife common options"
33
draft = false
44

55
[menu]
66
[menu.tools]
7-
title = "Knife common options"
8-
identifier = "tools/knife/common_options.md Knife Common Options"
7+
title = "knife common options"
8+
identifier = "tools/knife/common_options.md knife Common Options"
99
parent = "tools/knife"
1010
weight = 110
1111
+++

content/tools/knife/config_rb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
+++
2-
title = "Configure Knife"
2+
title = "Configure knife"
33
draft = false
44

55

66

77
[menu]
88
[menu.tools]
9-
title = "Configure Knife"
9+
title = "Configure knife"
1010
identifier = "tools/knife/config_rb.md config.rb (knife.rb)"
1111
parent = "tools/knife"
1212
weight = 40

content/tools/knife/config_rb_optional_settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Optional Knife settings"
2+
title = "Optional knife settings"
33
draft = false
44

55
[menu]

content/tools/knife/install.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Install Knife"
2+
title = "Install knife"
33

44
[menu.workstation]
55
title = "Install"
@@ -8,32 +8,32 @@ parent = "workstation/knife"
88
weight = 20
99
+++
1010

11-
Knife is included as a component of Chef Workstation, but you can also install it as a standalone package.
12-
The Knife standalone installation doesn't include the Knife cloud provider plugins (knife-ec2, knife-google, knife-windows).
13-
For that reason, Progress Chef recommends installing Chef Workstation, which includes Knife and the Knife cloud provider plugins.
11+
knife is included as a component of Chef Workstation, but you can also install it as a standalone package.
12+
The knife standalone installation doesn't include the knife cloud provider plugins (knife-ec2, knife-google, knife-windows).
13+
For that reason, Progress Chef recommends installing Chef Workstation, which includes knife and the knife cloud provider plugins.
1414

15-
If you want to install Knife as a standalone component, follow the steps below.
15+
If you want to install knife as a standalone component, follow the steps below.
1616

1717
## Requirements
1818

19-
Knife has the following requirements:
19+
knife has the following requirements:
2020

2121
- Supported on Linux (Ubuntu 18.04+, CentOS 7+, RHEL 7+), macOS 10.15+, or Windows 10/Server 2016+
2222
- Chef Habitat 1.6.0 or later installed
2323
- Internet connectivity for package download and bootstrapping remote nodes
2424
- SSH or WinRM to manage remote nodes
2525

26-
## Install the Knife standalone package
26+
## Install the knife standalone package
2727

28-
To install the Knife standalone package, follow these steps:
28+
To install the knife standalone package, follow these steps:
2929

30-
1. Install Knife:
30+
1. Install knife:
3131

3232
```sh
3333
hab pkg install chef/knife --channel unstable --binlink --force
3434
```
3535

36-
1. Optional: After installation, verify Knife is installed and working:
36+
1. Optional: After installation, verify knife is installed and working:
3737

3838
```sh
3939
knife --version

0 commit comments

Comments
 (0)