From d2c83c49441b73ce49e2da39fe1bf451c3467b82 Mon Sep 17 00:00:00 2001 From: Dan Barr Date: Thu, 4 Aug 2022 18:44:44 -0400 Subject: [PATCH] Update Golang references to Go * Fix any "golang" to just "Go" * Update golang.org URLs to go.dev --- website/content/docs/partnerships.mdx | 2 +- .../docs/plugins/creation/custom-builders.mdx | 2 +- website/content/docs/plugins/creation/index.mdx | 4 ++-- website/content/docs/post-processors/shell-local.mdx | 2 +- website/content/docs/provisioners/shell-local.mdx | 2 +- .../functions/datetime/legacy_isotime.mdx | 2 +- .../docs/templates/legacy_json_templates/engine.mdx | 12 ++++++------ website/content/guides/hcl/variables.mdx | 6 +++--- .../communicator/SSH-not-required.mdx | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/website/content/docs/partnerships.mdx b/website/content/docs/partnerships.mdx index 58e4397a8..2e46957f4 100644 --- a/website/content/docs/partnerships.mdx +++ b/website/content/docs/partnerships.mdx @@ -84,7 +84,7 @@ We encourage vendors to closely follow the above guidance. Adopting the same str #### 3. Dev & Test -Packer requires all code-level integrations to be written in the [Go](https://golang.org/) programming language and contain an [MPL-2.0](https://en.wikipedia.org/wiki/Mozilla_Public_License) open source license. The only knowledge necessary to write a plugin is basic command-line skills and knowledge of the Go programming language. When writing in Go-Language, HashiCorp has found the integration development process to be straightforward and simple when vendors pay close attention and follow the resources and by adopting the same structure and coding patterns helps expedite the review and release cycles. Please remember that all integration major steps should contain acceptance testing and the appropriate documentation. +Packer requires all code-level integrations to be written in the [Go](https://go.dev/) programming language and contain an [MPL-2.0](https://en.wikipedia.org/wiki/Mozilla_Public_License) open source license. The only knowledge necessary to write a plugin is basic command-line skills and knowledge of the Go programming language. When writing in Go, HashiCorp has found the integration development process to be straightforward and simple when vendors pay close attention and follow the resources and by adopting the same structure and coding patterns helps expedite the review and release cycles. Please remember that all integration major steps should contain acceptance testing and the appropriate documentation. Data Sources diff --git a/website/content/docs/plugins/creation/custom-builders.mdx b/website/content/docs/plugins/creation/custom-builders.mdx index 457c39acb..23a99a6b1 100644 --- a/website/content/docs/plugins/creation/custom-builders.mdx +++ b/website/content/docs/plugins/creation/custom-builders.mdx @@ -24,7 +24,7 @@ basics](/docs/extending/plugins). recommend getting comfortable with using Packer and its officially maintained plugins before you dive into writing plugins of your own. -Custom plugins are written in [golang](https://golang.org/), so this guide +Custom plugins are written in [Go](https://go.dev/), so this guide assumes that you have some familiarity with that programming language. ## The Interface diff --git a/website/content/docs/plugins/creation/index.mdx b/website/content/docs/plugins/creation/index.mdx index 36f4dd850..b378e390a 100644 --- a/website/content/docs/plugins/creation/index.mdx +++ b/website/content/docs/plugins/creation/index.mdx @@ -20,7 +20,7 @@ This page will document how you can develop your own Packer plugins. Prior to reading this, you should be comfortable with Packer and know the basics of [how plugins work from a user standpoint](/docs/plugins). -Packer plugins must be written in [Go](https://golang.org/), so you should also +Packer plugins must be written in [Go](https://go.dev/), so you should also be familiar with the language. ~> **Warning!** This is an advanced topic. If you're new to Packer, we @@ -39,7 +39,7 @@ launching and cleaning up the plugin processes. The components that can be created and used in a Packer plugin are builders, provisioners, post-processors, and data sources. -Each of these components has a corresponding [interface](https://golang.org/doc/effective_go.html#interfaces_and_types). +Each of these components has a corresponding [interface](https://go.dev/doc/effective_go.html#interfaces_and_types). All you need to do to create a plugin is: diff --git a/website/content/docs/post-processors/shell-local.mdx b/website/content/docs/post-processors/shell-local.mdx index 7d16aa716..ffe640bbd 100644 --- a/website/content/docs/post-processors/shell-local.mdx +++ b/website/content/docs/post-processors/shell-local.mdx @@ -168,7 +168,7 @@ Optional parameters: post-processor after your shell-local processor has run. - `only_on` (array of strings) - This is an array of [runtime operating - systems](https://golang.org/doc/install/source#environment) where + systems](https://go.dev/doc/install/source#environment) where `shell-local` will execute. This allows you to execute `shell-local` _only_ on specific operating systems. By default, shell-local will always run if `only_on` is not set." diff --git a/website/content/docs/provisioners/shell-local.mdx b/website/content/docs/provisioners/shell-local.mdx index 4e54f9892..79fe1d7f4 100644 --- a/website/content/docs/provisioners/shell-local.mdx +++ b/website/content/docs/provisioners/shell-local.mdx @@ -161,7 +161,7 @@ Optional parameters: provisioner. - `only_on` (array of strings) - This is an array of [runtime operating - systems](https://golang.org/doc/install/source#environment) where + systems](https://go.dev/doc/install/source#environment) where `shell-local` will execute. This allows you to execute `shell-local` _only_ on specific operating systems. By default, shell-local will always run if `only_on` is not set." diff --git a/website/content/docs/templates/hcl_templates/functions/datetime/legacy_isotime.mdx b/website/content/docs/templates/hcl_templates/functions/datetime/legacy_isotime.mdx index 26db7c2fd..05c39844a 100644 --- a/website/content/docs/templates/hcl_templates/functions/datetime/legacy_isotime.mdx +++ b/website/content/docs/templates/hcl_templates/functions/datetime/legacy_isotime.mdx @@ -8,7 +8,7 @@ description: |- # `legacy_isotime` Function The `legacy_isotime` function returns the current date and time using the given format string. -The format string follows golang's datetime formatting. See +The format string follows Go's datetime formatting. See [isotime-function-format-reference](/docs/templates/legacy_json_templates/engine#isotime-function-format-reference) for more details. diff --git a/website/content/docs/templates/legacy_json_templates/engine.mdx b/website/content/docs/templates/legacy_json_templates/engine.mdx index 706b3bd62..3a672f592 100644 --- a/website/content/docs/templates/legacy_json_templates/engine.mdx +++ b/website/content/docs/templates/legacy_json_templates/engine.mdx @@ -119,7 +119,7 @@ Here is a full list of the available functions for reference. issue tracker on GitHub. - `isotime [FORMAT]` - UTC time, which can be - [formatted](https://golang.org/pkg/time/#example_Time_Format). See more + [formatted](https://pkg.go.dev/time#example_Time_Format). See more examples below in [the `isotime` format reference](/docs/templates/legacy_json_templates/engine#isotime-function-format-reference). `strftime FORMAT` - UTC time, formated using the ISO C standard format @@ -236,15 +236,15 @@ documentation for more information on user variables. # isotime Function Format Reference -The isotime template engine uses golang to generate timestamps. If you're -unfamiliar with golang, then the way you format the timestamp is going to +The isotime template engine uses Go to generate timestamps. If you're +unfamiliar with Go, then the way you format the timestamp is going to feel a bit unusual compared to how you may be used to formatting datetime strings. -Full docs and examples for the golang time formatting function can be found -[here](https://golang.org/pkg/time/#example_Time_Format) +Full docs and examples for the Go time formatting function can be found +[here](https://pkg.go.dev/time#example_Time_Format) -However, the formatting basics are worth describing here. From the [golang docs](https://golang.org/pkg/time/#pkg-constants): +However, the formatting basics are worth describing here. From the [Go docs](https://pkg.go.dev/time#pkg-constants): > These are predefined layouts for use in Time.Format and time.Parse. The > reference time used in the layouts is the specific time: diff --git a/website/content/guides/hcl/variables.mdx b/website/content/guides/hcl/variables.mdx index c32b2fc91..b8952c7cd 100644 --- a/website/content/guides/hcl/variables.mdx +++ b/website/content/guides/hcl/variables.mdx @@ -120,9 +120,9 @@ build { ] provisioner "shell-local" { // Note that for options that are documented as template engines, - // we still have to use the golang template engine syntax rather than our + // we still have to use the Go template engine syntax rather than our // specialized HCL2 variable syntax. This example shows a combination of - // an HCL2 variable and the golang template engines built into the + // an HCL2 variable and the Go template engines built into the // execute_command option execute_command = ["/bin/sh", "-c", "echo ${var.sudo_password}| {{.Vars}} {{.Script}}"] environment_vars = ["HELLO_USER=packeruser", "UUID=${build.PackerRunUUID}"] @@ -139,7 +139,7 @@ build { As you can see in the example, you can access your variables directly by giving them the `var.` or `local.` prefix. If you want to embed the variables in a string, you can do so with the `${}` HCL interpolation syntax. If you are -using an option that is a template engine, you still need to use the golang +using an option that is a template engine, you still need to use the Go templating engine syntax `{{ .OPTION }}` for those engines. ## Assigning Variables diff --git a/website/content/partials/packer-plugin-sdk/communicator/SSH-not-required.mdx b/website/content/partials/packer-plugin-sdk/communicator/SSH-not-required.mdx index 266148a5d..61b1be6ac 100644 --- a/website/content/partials/packer-plugin-sdk/communicator/SSH-not-required.mdx +++ b/website/content/partials/packer-plugin-sdk/communicator/SSH-not-required.mdx @@ -9,7 +9,7 @@ - `ssh_password` (string) - A plaintext password to use to authenticate with SSH. -- `ssh_ciphers` ([]string) - This overrides the value of ciphers supported by default by golang. +- `ssh_ciphers` ([]string) - This overrides the value of ciphers supported by default by Go. The default value is [ "aes128-gcm@openssh.com", "chacha20-poly1305@openssh.com", @@ -29,7 +29,7 @@ currently only works on guests with `sed` installed. - `ssh_key_exchange_algorithms` ([]string) - If set, Packer will override the value of key exchange (kex) altorighms - supported by default by golang. Acceptable values include: + supported by default by Go. Acceptable values include: "curve25519-sha256@libssh.org", "ecdh-sha2-nistp256", "ecdh-sha2-nistp384", "ecdh-sha2-nistp521", "diffie-hellman-group14-sha1", and "diffie-hellman-group1-sha1".