Skip to content

Commit bc6f1e3

Browse files
authored
Fixes typos in docs (#11322)
* fixes typos in base docs * fixes typos in example code * fixes typos in website docs * fixes link to Terraform provider * fixes typo in function name
1 parent 7ebc855 commit bc6f1e3

File tree

20 files changed

+36
-38
lines changed

20 files changed

+36
-38
lines changed

.github/CONTRIBUTING.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ contribute to the project, read on. This document will cover what we're looking
1111
for. By addressing all the points we're looking for, it raises the chances we
1212
can quickly merge or address your contributions.
1313

14-
When contributing in any way to the Packer project (new issue, PR, etc), please
15-
be aware that our team identifies with many gender pronouns. Please remember to
16-
use nonbinary pronouns (they/them) and gender neutral language ("Hello folks")
17-
when addressing our team. For more reading on our code of conduct, please see the
14+
When contributing in any way to the Packer project (new issue, PR, etc), please
15+
be aware that our team identifies with many gender pronouns. Please remember to
16+
use nonbinary pronouns (they/them) and gender neutral language ("Hello folks")
17+
when addressing our team. For more reading on our code of conduct, please see the
1818
[HashiCorp community guidelines](https://www.hashicorp.com/community-guidelines).
1919

2020
## Issues
@@ -53,18 +53,16 @@ when addressing our team. For more reading on our code of conduct, please see th
5353
linked.
5454

5555
5. Sometimes, if you have a specialized environment or use case, the maintainers
56-
may ask for your help testing the patch. You are able to download an
56+
may ask for your help to test the patch. You are able to download an
5757
experimental binary of Packer containing the Pull Request's patch via from
58-
the Pull Request page on github. You can do this by scrolling to the
59-
"checks" section on github, and clicking "details" on the
58+
the Pull Request page on GitHub. You can do this by scrolling to the
59+
"checks" section on GitHub, and clicking "details" on the
6060
"store_artifacts" check. This will take you to Packer's Circle CI page for
6161
the build, and you will be able to click a tab named "Artifacts" which will
6262
contain zipped Packer binaries for each major OS architecture.
6363

6464
6. The issue is closed.
6565

66-
67-
6866
## Setting up Go
6967

7068
If you have never worked with Go before, you will have to install its
@@ -121,14 +119,14 @@ executable extension
121119
go build -o bin/packer.exe
122120
```
123121

124-
### Opening an Pull Request
122+
### Opening a Pull Request
125123

126124
Thank you for contributing! When you are ready to open a pull-request, you will
127125
need to [fork
128126
Packer](https://github.com/hashicorp/packer#fork-destination-box), push your
129127
changes to your fork, and then open a pull-request.
130128

131-
For example, my github username is `cbednarski`, so I would do the following:
129+
For example, my GitHub username is `cbednarski`, so I would do the following:
132130

133131
```
134132
git checkout -b f-my-feature

.github/ISSUE_TEMPLATE/bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug Report
3-
about: You're experiencing an issue with Packer that is different than the documented behavior.
3+
about: You're experiencing an issue with Packer that is different from the documented behavior.
44
labels: bug
55
---
66

@@ -19,7 +19,7 @@ Steps to reproduce this issue
1919

2020
From `packer version`
2121

22-
### Simplified Packer Buildfile
22+
### Simplified Packer Template
2323

2424
If the file is longer than a few dozen lines, please include the URL to the
2525
[gist](https://gist.github.com/) of the log or use the [Github detailed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ What does **unmaintained** mean?
116116
1. Issues and pull requests are monitored as a best effort.
117117
1. No active development will be performed by the Packer team.
118118

119-
If anyone form them community is interested in maintaining a community
119+
If anyone from the community is interested in maintaining a community
120120
supported plugin, please feel free to submit contributions via a pull-
121121
request for review; reviews are generally prioritized over feature work
122122
when possible. For a list of open plugin issues and pending feature requests see the [Packer Issue Tracker](https://github.com/hashicorp/packer/issues/).

examples/hcl/linux/build.alpine.pkr.hcl

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build {
44
description = <<EOF
55
This build creates alpine images for versions :
66
* v3.12
7-
For the following builers :
7+
For the following builders :
88
* virtualbox-iso
99
EOF
1010

examples/hcl/linux/build.ubuntu.pkr.hcl

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ build {
44
description = <<EOF
55
This build creates ubuntu images for ubuntu versions :
66
* 16.04
7-
* 18.04
8-
For the following builers :
7+
* 18.04
8+
For the following builders :
99
* virtualbox-iso
1010
* parallels-iso
1111
* vmware-iso
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
build {
3-
post-processor "inexistant" {
3+
post-processor "nonexistent" {
44
foo = "bar"
55
}
66
}
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
data "inexistant" "test" {
1+
data "nonexistent" "test" {
22
foo = "bar"
33
}

packer/plugin-getter/github/getter.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ type Getter struct {
3333

3434
var _ plugingetter.Getter = &Getter{}
3535

36-
func tranformChecksumStream() func(in io.ReadCloser) (io.ReadCloser, error) {
36+
func transformChecksumStream() func(in io.ReadCloser) (io.ReadCloser, error) {
3737
return func(in io.ReadCloser) (io.ReadCloser, error) {
3838
defer in.Close()
3939
rd := bufio.NewReader(in)
@@ -202,7 +202,7 @@ func (g *Getter) Get(what string, opts plugingetter.GetOptions) (io.ReadCloser,
202202
u,
203203
nil,
204204
)
205-
transform = tranformChecksumStream()
205+
transform = transformChecksumStream()
206206
case "zip":
207207
u := filepath.ToSlash("https://github.com/" + opts.PluginRequirement.Identifier.RealRelativePath() + "/releases/download/" + opts.Version() + "/" + opts.ExpectedZipFilename())
208208
req, err = g.Client.NewRequest(

website/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If your local development environment has a supported version (v10.0.0+) of [nod
5858

5959
...and then visit `http://localhost:3000`.
6060

61-
If you pull down new code from github, you should run `npm install` again. Otherwise, there's no need to re-run `npm install` each time the site is run, you can just run `npm start` to get it going.
61+
If you pull down new code from GitHub, you should run `npm install` again. Otherwise, there's no need to re-run `npm install` each time the site is run, you can just run `npm start` to get it going.
6262

6363
<!-- END: local-development -->
6464

@@ -96,7 +96,7 @@ There is currently a small bug with new page creation - if you create a new page
9696

9797
### Markdown Enhancements
9898

99-
There are several custom markdown plugins that are available by default that enhance [standard markdown](https://commonmark.org/) to fit our use cases. This set of plugins introduces a couple instances of custom syntax, and a couple specific pitfalls that are not present by default with markdown, detailed below:
99+
There are several custom Markdown plugins that are available by default that enhance [standard markdown](https://commonmark.org/) to fit our use cases. This set of plugins introduces a couple instances of custom syntax, and a couple specific pitfalls that are not present by default with markdown, detailed below:
100100

101101
- If you see the symbols `~>`, `->`, `=>`, or `!>`, these represent [custom alerts](https://github.com/hashicorp/remark-plugins/tree/master/plugins/paragraph-custom-alerts#paragraph-custom-alerts). These render as colored boxes to draw the user's attention to some type of aside.
102102
- If you see `@include '/some/path.mdx'`, this is a [markdown include](https://github.com/hashicorp/remark-plugins/tree/master/plugins/include-markdown#include-markdown-plugin). It's worth noting as well that all includes resolve from `website/content/partials` by default, and that changes to partials will not live-reload the website.
@@ -192,7 +192,7 @@ Now let's look at inline usage, here's an example:
192192

193193
![Enterprise Alert Component - Inline](https://p176.p0.n0.cdn.getcloudapp.com/items/L1upYLEJ/Screen%20Shot%202020-06-11%20at%206.07.50%20PM.png?v=013ba439263de8292befbc851d31dd78)
194194

195-
And here's how it could be used in your markdown document:
195+
And here's how it could be used in your Markdown document:
196196

197197
```mdx
198198
### Some Enterprise Feature <EnterpriseAlert inline />
@@ -220,7 +220,7 @@ When using fenced code blocks, the recommendation is to tag the code block with
220220
```
221221
````
222222

223-
Check out the [supported languages list](https://prismjs.com/#supported-languages) for the syntax highlighter we use if you want to double check the language name.
223+
Check out the [supported languages list](https://prismjs.com/#supported-languages) for the syntax highlighter we use if you want to double-check the language name.
224224

225225
It is also worth noting specifically that if you are using a code block that is an example of a terminal command, the correct language tag is `shell-session`. For example:
226226

@@ -565,6 +565,6 @@ We support the following browsers targeting roughly the versions specified.
565565

566566
## Deployment
567567

568-
This website is hosted on Vercel and configured to automatically deploy anytime you push code to the `stable-website` branch. Any time a pull request is submitted that changes files within the `website` folder, a deployment preview will appear in the github checks which can be used to validate the way docs changes will look live. Deployments from `stable-website` will look and behave the same way as deployment previews.
568+
This website is hosted on Vercel and configured to automatically deploy anytime you push code to the `stable-website` branch. Any time a pull request is submitted that changes files within the `website` folder, a deployment preview will appear in the GitHub checks which can be used to validate the way docs changes will look live. Deployments from `stable-website` will look and behave the same way as deployment previews.
569569

570570
<!-- END: deployment -->

website/content/community-plugins.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ maintained by HashiCorp. Any plugins not on this list are maintained by the
1010
community, and not actively contributed to by HashiCorp, although they are
1111
still distributed with Packer. If you are interested in seeing features or
1212
bugfixes to these plugins, please consider making a pull request, or asking the
13-
HashiCorp maintainters for advice on how to get started contributing.
13+
HashiCorp maintainers for advice on how to get started contributing.
1414

1515
## Builders
1616

website/content/docs/commands/console.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ packer console file.pkr.hcl
135135

136136
Because the file is suffixed with `.pkr.hcl` Packer will start in HCL2 mode.
137137

138-
When you just want to play arround without a config file you can set the
138+
When you just want to play around without a config file you can set the
139139
`--config-type=hcl2` option and Packer will start in HCL2 mode:
140140

141141
```shell-session

website/content/docs/commands/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ You'll see these data types when you run `packer build`:
107107
mode. There are three "data" subtypes associated with this type:
108108

109109
- `say`: in a non-machine-readable format, this would be bolded. Normally
110-
it is used for anouncements about beginning new steps in the build
110+
it is used for announcements about beginning new steps in the build
111111
process
112112

113113
- `message`: the most commonly used message type, used for basic updates

website/content/docs/plugins/creation/custom-builders.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -198,13 +198,13 @@ necessary.
198198
If you are using the multistep tooling, the Packer plugin SDK contains a
199199
generic StepProvision which handles execution the provision hook for you and
200200
automatically supplies any custom builder generatedData you would like to
201-
provide to procisioners (see below for more details on generatedData.)
201+
provide to provisioners (see below for more details on generatedData.)
202202

203203
## Template Engine
204204

205205
~> Note: In HCL2 the JSON template engine and generated data is slowly going to
206206
be deprecated in favor of using HCL2 objects, we will keep on supporting those
207-
but it is recomended to avoid using them if you can.
207+
but it is recommended to avoid using them if you can.
208208

209209
### Build variables
210210

website/content/docs/plugins/creation/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ Follow the next steps to get the Packer website running and preview the document
309309

310310
#### Working Examples
311311

312-
Here's a non exaustive list of Packer plugins that you can check out:
312+
Here's a non-exhaustive list of Packer plugins that you can check out:
313313

314314
- [github.com/hashicorp/packer-plugin-docker](https://github.com/hashicorp/packer-plugin-docker)
315315
- [github.com/exoscale/packer-plugin-exoscale](https://github.com/exoscale/packer-plugin-exoscale)

website/content/docs/templates/hcl_templates/blocks/source.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ the unique name or identifier you want to give to the source. There can be only
1818
once. Builders are usually found in plugins, except for the `file` and the
1919
`null` builders that will remain in Packer core.
2020

21-
You can start builders by refering to those source blocks from a [`build`
21+
You can start builders by referring to those source blocks from a [`build`
2222
block](/docs/templates/hcl_templates/blocks/build) :
2323

2424
```hcl

website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ to YAML tags in the following way:
4141
| `object(...)` | `!!map` |
4242
| Null value | `!!null` |
4343

44-
`yamlencode` uses the implied syntaxes for all of the above types, so it does
44+
`yamlencode` uses the implied syntax for all of the above types, so it does
4545
not generate explicit YAML tags.
4646

4747
Because the YAML format cannot fully represent all of the Packer language

website/content/docs/templates/hcl_templates/functions/string/format.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ omitted then default values are selected based on the given value. For example:
9292
| `%9.2f` | Width 9, precision 2. |
9393

9494
The following additional symbols can be used immediately after the `%` symbol
95-
to set additoinal flags:
95+
to set additional flags:
9696

9797
| Symbol | Result |
9898
| ------ | -------------------------------------------------------------- |

website/content/guides/automatic-operating-system-installs/autounattend_windows.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
page_title: Unattended Windows Installation
33
description: |-
44
Learn how to use an autounattend file to automatically answer installation
5-
questions and enable Packer to connect to your windows instnace.
5+
questions and enable Packer to connect to your windows instance.
66
---
77

88
# Unattended Installation for Windows

website/content/guides/automatic-operating-system-installs/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
page_title: Automatic OS Installs
33
description: |-
44
Learn how to use preseed, kickstart, and autounattend files to automatically
5-
answer installation questions and enable Packer to connect to your instnace.
5+
answer installation questions and enable Packer to connect to your instance.
66
---
77

88
# Automatic OS Installs

website/content/guides/packer-on-cicd/build-virtualbox-image.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ a `baremetal_0` server type for testing, but for regular use, the `baremetal_1`
3030
instance may be a better option.
3131

3232
There is also a [Packet
33-
Provider](https://www.terraform.io/docs/providers/packet/index.html) in
33+
Provider](https://registry.terraform.io/providers/packethost/packet/latest/docs) in
3434
Terraform you can use to provision the project and instance.
3535

3636
```hcl

0 commit comments

Comments
 (0)