upstream/packer
1
0
Fork 0
mirror of https://github.com/hashicorp/packer.git synced 2025-12-18 23:16:06 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Fixes typos in docs (#11322)

Browse source 
* 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
This commit is contained in:
Kerim Satirli 2021-10-11 10:19:49 +02:00 committed by GitHub
parent 7ebc85564b
commit bc6f1e36e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 36 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
.github/CONTRIBUTING.md vendored
View file

@ -11,10 +11,10 @@ contribute to the project, read on. This document will cover what we're looking
for. By addressing all the points we're looking for, it raises the chances we
can quickly merge or address your contributions.
When contributing in any way to the Packer project (new issue, PR, etc), please
be aware that our team identifies with many gender pronouns. Please remember to
use nonbinary pronouns (they/them) and gender neutral language ("Hello folks")
when addressing our team. For more reading on our code of conduct, please see the
When contributing in any way to the Packer project (new issue, PR, etc), please
be aware that our team identifies with many gender pronouns. Please remember to
use nonbinary pronouns (they/them) and gender neutral language ("Hello folks")
when addressing our team. For more reading on our code of conduct, please see the
[HashiCorp community guidelines](https://www.hashicorp.com/community-guidelines).
## Issues
@ -53,18 +53,16 @@ when addressing our team. For more reading on our code of conduct, please see th
linked.
5. Sometimes, if you have a specialized environment or use case, the maintainers
may ask for your help testing the patch. You are able to download an
may ask for your help to test the patch. You are able to download an
experimental binary of Packer containing the Pull Request's patch via from
the Pull Request page on github. You can do this by scrolling to the
"checks" section on github, and clicking "details" on the
the Pull Request page on GitHub. You can do this by scrolling to the
"checks" section on GitHub, and clicking "details" on the
"store_artifacts" check. This will take you to Packer's Circle CI page for
the build, and you will be able to click a tab named "Artifacts" which will
contain zipped Packer binaries for each major OS architecture.
6. The issue is closed.
## Setting up Go
If you have never worked with Go before, you will have to install its
@ -121,14 +119,14 @@ executable extension
go build -o bin/packer.exe
```
### Opening an Pull Request
### Opening a Pull Request
Thank you for contributing! When you are ready to open a pull-request, you will
need to [fork
Packer](https://github.com/hashicorp/packer#fork-destination-box), push your
changes to your fork, and then open a pull-request.
For example, my github username is `cbednarski`, so I would do the following:
For example, my GitHub username is `cbednarski`, so I would do the following:
```
git checkout -b f-my-feature

4
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -1,6 +1,6 @@
---
name: Bug Report
about: You're experiencing an issue with Packer that is different than the documented behavior.
about: You're experiencing an issue with Packer that is different from the documented behavior.
labels: bug
---
@ -19,7 +19,7 @@ Steps to reproduce this issue
From `packer version`
### Simplified Packer Buildfile
### Simplified Packer Template
If the file is longer than a few dozen lines, please include the URL to the
[gist](https://gist.github.com/) of the log or use the [Github detailed

2
README.md
View file

@ -116,7 +116,7 @@ What does **unmaintained** mean?
1. Issues and pull requests are monitored as a best effort.
1. No active development will be performed by the Packer team.
If anyone form them community is interested in maintaining a community
If anyone from the community is interested in maintaining a community
supported plugin, please feel free to submit contributions via a pull-
request for review; reviews are generally prioritized over feature work
when possible. For a list of open plugin issues and pending feature requests see the [Packer Issue Tracker](https://github.com/hashicorp/packer/issues/).

2
examples/hcl/linux/build.alpine.pkr.hcl
View file

@ -4,7 +4,7 @@ build {
description = <<EOF
This build creates alpine images for versions :
* v3.12
For the following builers :
For the following builders :
* virtualbox-iso
EOF

4
examples/hcl/linux/build.ubuntu.pkr.hcl
View file

@ -4,8 +4,8 @@ build {
description = <<EOF
This build creates ubuntu images for ubuntu versions :
* 16.04
* 18.04
For the following builers :
* 18.04
For the following builders :
* virtualbox-iso
* parallels-iso
* vmware-iso

2
hcl2template/testdata/build/post-processor_inexistent.pkr.hcl vendored
View file

@ -1,6 +1,6 @@
build {
post-processor "inexistant" {
post-processor "nonexistent" {
foo = "bar"
}
}

2
hcl2template/testdata/datasources/inexistent.pkr.hcl vendored
View file

@ -1,3 +1,3 @@
data "inexistant" "test" {
data "nonexistent" "test" {
foo = "bar"
}

4
packer/plugin-getter/github/getter.go
View file

@ -33,7 +33,7 @@ type Getter struct {
var _ plugingetter.Getter = &Getter{}
func tranformChecksumStream() func(in io.ReadCloser) (io.ReadCloser, error) {
func transformChecksumStream() func(in io.ReadCloser) (io.ReadCloser, error) {
return func(in io.ReadCloser) (io.ReadCloser, error) {
defer in.Close()
rd := bufio.NewReader(in)
@ -202,7 +202,7 @@ func (g *Getter) Get(what string, opts plugingetter.GetOptions) (io.ReadCloser,
u,
nil,
)
transform = tranformChecksumStream()
transform = transformChecksumStream()
case "zip":
u := filepath.ToSlash("https://github.com/" + opts.PluginRequirement.Identifier.RealRelativePath() + "/releases/download/" + opts.Version() + "/" + opts.ExpectedZipFilename())
req, err = g.Client.NewRequest(

10
website/README.md
View file

@ -58,7 +58,7 @@ If your local development environment has a supported version (v10.0.0+) of [nod
...and then visit `http://localhost:3000`.
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.
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.
<!-- END: local-development -->
@ -96,7 +96,7 @@ There is currently a small bug with new page creation - if you create a new page
### Markdown Enhancements
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:
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:
- 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.
- 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:
![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)
And here's how it could be used in your markdown document:
And here's how it could be used in your Markdown document:
```mdx
### Some Enterprise Feature <EnterpriseAlert inline />
@ -220,7 +220,7 @@ When using fenced code blocks, the recommendation is to tag the code block with
```
````
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.
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.
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:
@ -565,6 +565,6 @@ We support the following browsers targeting roughly the versions specified.
## Deployment
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.
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.
<!-- END: deployment -->

2
website/content/community-plugins.mdx
View file

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

2
website/content/docs/commands/console.mdx
View file

@ -135,7 +135,7 @@ packer console file.pkr.hcl
Because the file is suffixed with `.pkr.hcl` Packer will start in HCL2 mode.
When you just want to play arround without a config file you can set the
When you just want to play around without a config file you can set the
`--config-type=hcl2` option and Packer will start in HCL2 mode:
```shell-session

2
website/content/docs/commands/index.mdx
View file

@ -107,7 +107,7 @@ You'll see these data types when you run `packer build`:
mode. There are three "data" subtypes associated with this type:
- `say`: in a non-machine-readable format, this would be bolded. Normally
it is used for anouncements about beginning new steps in the build
it is used for announcements about beginning new steps in the build
process
- `message`: the most commonly used message type, used for basic updates

4
website/content/docs/plugins/creation/custom-builders.mdx
View file

@ -198,13 +198,13 @@ necessary.
If you are using the multistep tooling, the Packer plugin SDK contains a
generic StepProvision which handles execution the provision hook for you and
automatically supplies any custom builder generatedData you would like to
provide to procisioners (see below for more details on generatedData.)
provide to provisioners (see below for more details on generatedData.)
## Template Engine
~> Note: In HCL2 the JSON template engine and generated data is slowly going to
be deprecated in favor of using HCL2 objects, we will keep on supporting those
but it is recomended to avoid using them if you can.
but it is recommended to avoid using them if you can.
### Build variables

2
website/content/docs/plugins/creation/index.mdx
View file

@ -309,7 +309,7 @@ Follow the next steps to get the Packer website running and preview the document
#### Working Examples
Here's a non exaustive list of Packer plugins that you can check out:
Here's a non-exhaustive list of Packer plugins that you can check out:
- [github.com/hashicorp/packer-plugin-docker](https://github.com/hashicorp/packer-plugin-docker)
- [github.com/exoscale/packer-plugin-exoscale](https://github.com/exoscale/packer-plugin-exoscale)

2
website/content/docs/templates/hcl_templates/blocks/source.mdx vendored
View file

@ -18,7 +18,7 @@ the unique name or identifier you want to give to the source. There can be only
once. Builders are usually found in plugins, except for the `file` and the
`null` builders that will remain in Packer core.
You can start builders by refering to those source blocks from a [`build`
You can start builders by referring to those source blocks from a [`build`
block](/docs/templates/hcl_templates/blocks/build) :
```hcl

2
website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx vendored
View file

@ -41,7 +41,7 @@ to YAML tags in the following way:
| `object(...)` | `!!map` |
| Null value | `!!null` |
`yamlencode` uses the implied syntaxes for all of the above types, so it does
`yamlencode` uses the implied syntax for all of the above types, so it does
not generate explicit YAML tags.
Because the YAML format cannot fully represent all of the Packer language

2
website/content/docs/templates/hcl_templates/functions/string/format.mdx vendored
View file

@ -92,7 +92,7 @@ omitted then default values are selected based on the given value. For example:
| `%9.2f` | Width 9, precision 2. |
The following additional symbols can be used immediately after the `%` symbol
to set additoinal flags:
to set additional flags:
| Symbol | Result |
| ------ | -------------------------------------------------------------- |

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

@ -2,7 +2,7 @@
page_title: Unattended Windows Installation
description: |-
Learn how to use an autounattend file to automatically answer installation
questions and enable Packer to connect to your windows instnace.
questions and enable Packer to connect to your windows instance.
---
# Unattended Installation for Windows

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

@ -2,7 +2,7 @@
page_title: Automatic OS Installs
description: |-
Learn how to use preseed, kickstart, and autounattend files to automatically
answer installation questions and enable Packer to connect to your instnace.
answer installation questions and enable Packer to connect to your instance.
---
# Automatic OS Installs

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

@ -30,7 +30,7 @@ a `baremetal_0` server type for testing, but for regular use, the `baremetal_1`
instance may be a better option.
There is also a [Packet
Provider](https://www.terraform.io/docs/providers/packet/index.html) in
Provider](https://registry.terraform.io/providers/packethost/packet/latest/docs) in
Terraform you can use to provision the project and instance.
```hcl