From 8eb277b122e4132530f60964954d3cf2a0317108 Mon Sep 17 00:00:00 2001 From: trujillo-adam Date: Tue, 21 Jan 2025 19:30:41 -0800 Subject: [PATCH 1/2] seo improvements data sources references --- .../datasources/hcp/hcp-packer-artifact.mdx | 15 +++---- .../docs/datasources/hcp/hcp-packer-image.mdx | 15 +++---- .../datasources/hcp/hcp-packer-iteration.mdx | 14 +++---- .../datasources/hcp/hcp-packer-version.mdx | 23 +++++----- .../content/docs/datasources/hcp/index.mdx | 42 ++++++++----------- website/content/docs/datasources/http.mdx | 11 ++--- website/content/docs/datasources/index.mdx | 9 ++-- website/data/docs-nav-data.json | 26 ++++++++---- 8 files changed, 69 insertions(+), 86 deletions(-) diff --git a/website/content/docs/datasources/hcp/hcp-packer-artifact.mdx b/website/content/docs/datasources/hcp/hcp-packer-artifact.mdx index e0fc58c030d..f1332f6f70b 100644 --- a/website/content/docs/datasources/hcp/hcp-packer-artifact.mdx +++ b/website/content/docs/datasources/hcp/hcp-packer-artifact.mdx @@ -1,9 +1,8 @@ --- description: | - The HCP Packer Artifact Data Source retrieves information about an - artifact from the HCP Packer Registry. This information can be used to - provide a source artifact to various Packer builders. -page_title: HCP Packer Artifact - Data Sources + The `hcp-packer-artifact` data source retrieves information about an + artifact from the HCP Packer Registry. Use the information to provide a source artifact to Packer builders. +page_title: hcp-packer-artifact data source reference --- @@ -11,12 +10,10 @@ page_title: HCP Packer Artifact - Data Sources -# HCP Packer Artifact Data Source +# `hcp-packer-artifact` -Type: `hcp-packer-artifact` - -The `HCP Packer Artifact` Data Source retrieves information about an -artifact from the HCP Packer Registry. This information can be used to +The `hcp-packer-artifact` data source retrieves information about an +artifact from the HCP Packer Registry. Use this retrieved information to provide a source artifact to various Packer builders. To get started with HCP Packer, refer to the [HCP Packer documentation](/hcp/docs/packer) or try diff --git a/website/content/docs/datasources/hcp/hcp-packer-image.mdx b/website/content/docs/datasources/hcp/hcp-packer-image.mdx index d7312921cb4..bab62a11361 100644 --- a/website/content/docs/datasources/hcp/hcp-packer-image.mdx +++ b/website/content/docs/datasources/hcp/hcp-packer-image.mdx @@ -1,23 +1,18 @@ --- description: | - This data source has been deprecated, please use HCP Packer Artifact data source instead. - The HCP Packer Image Data Source retrieves information about an - image from the HCP Packer registry. This information can be used to - provide a source image to various Packer builders. -page_title: HCP Packer Image - Data Sources + The `hcp-packer-image` data source retrieves information about an image from the HCP Packer registry. This data source has been deprecated, use the `hcp-packer-artifact` data source instead. +page_title: hcp-packer-image data source reference --- -# HCP Packer Image Data Source +# `hcp-packer-image` -~> **Note:** This data source has been deprecated, please use [HCP Packer Artifact](/packer/docs/datasources/hcp/hcp-packer-artifact) data source instead. +~> **This data source id deprecated**. Use the [`hcp-packer-artifact`](/packer/docs/datasources/hcp/hcp-packer-artifact) data source instead. -Type: `hcp-packer-image` - -The `HCP Packer Image` Data Source retrieves information about an +The `hcp-packer-image` data source retrieves information about an image from the HCP Packer registry. This information can be used to provide a source image to various Packer builders. diff --git a/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx b/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx index 6ad6fb3c396..a1bfc44744d 100644 --- a/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx +++ b/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx @@ -1,21 +1,17 @@ --- description: | - This data source has been deprecated, please use HCP Packer Version data source instead. - The HCP Packer Iteration Data Source retrieves information about an - iteration from the HCP Packer registry. This information can be used to - query HCP for a source image for various Packer builders. -page_title: HCP Packer Iteration - Data Sources + The `hcp-packer-iteration` data source retrieves information about an +iteration from the HCP Packer registry. This data source is deprecated. Use the `hcpe-packer-verion` data source instead. +page_title: hcp-packer-iteration data source reference --- -# HCP Packer Iteration Data Source +# `hcp-packer-iteration` -~> **Note:** This data source has been deprecated, please use [HCP Packer Version](/packer/docs/datasources/hcp/hcp-packer-version) data source instead. - -Type: `hcp-packer-iteration` +~> **This data source is deprecated**. Use the [`hcp-packer-version`](/packer/docs/datasources/hcp/hcp-packer-version) data source instead. The `HCP Packer Iteration` Data Source retrieves information about an iteration from the HCP Packer registry. This information can be used to query diff --git a/website/content/docs/datasources/hcp/hcp-packer-version.mdx b/website/content/docs/datasources/hcp/hcp-packer-version.mdx index b84efdf405d..d9a250cb795 100644 --- a/website/content/docs/datasources/hcp/hcp-packer-version.mdx +++ b/website/content/docs/datasources/hcp/hcp-packer-version.mdx @@ -1,9 +1,9 @@ --- description: | - The HCP Packer Version Data Source retrieves information about - HCP Packer Version from the HCP Packer Registry. This information can be used to - query HCP for a source external identifier for various Packer builders. -page_title: HCP Packer Version - Data Sources + The `hcp-packer-version` data source retrieves information about + the HCP Packer version from the HCP Packer registry. Use this information to + get a source's external identifier. +page_title: hcp-packer-version data source reference --- @@ -11,20 +11,17 @@ page_title: HCP Packer Version - Data Sources -# HCP Packer Version Data Source +# `hcp-packer-version` -Type: `hcp-packer-version` - -The `HCP Packer Version` Data Source retrieves information about -HCP Packer Version from the HCP Packer Registry. This information can be used to -query HCP for a source external identifier for various Packer builders. +The `hcp-packer-version` dsata source retrieves information about +the HCP Packer version from the HCP Packer registry. You can use the version information to +query HCP for a source's external identifier so that you can use it in various Packer builders. To get started with HCP Packer, refer to the [HCP Packer documentation](/hcp/docs/packer) or try the [Get Started with HCP Packer tutorials](/packer/tutorials/hcp-get-started). -~> **Note:** You will receive an error if you try to reference metadata from a deactivated or deleted registry. -An administrator can manually deactivate or delete a registry, and HCP Packer automatically deactivates registries -with billing issues. Contact [HashiCorp Support](https://support.hashicorp.com/) with questions. +Packer prints an error if you try to reference metadata from a deactivated or deleted registry. +An administrator can manually deactivate or delete a registry, and HCP Packer automatically deactivates registries with billing issues. Contact [HashiCorp Support](https://support.hashicorp.com/) with questions. ## Revoked Versions diff --git a/website/content/docs/datasources/hcp/index.mdx b/website/content/docs/datasources/hcp/index.mdx index 7f5fff7616a..74df7791bd9 100644 --- a/website/content/docs/datasources/hcp/index.mdx +++ b/website/content/docs/datasources/hcp/index.mdx @@ -1,7 +1,7 @@ --- description: | - Data sources used to data from the HCP Packer registry. -page_title: HCP - Data sources + HCP Packer data sources query data stored to the HCP Packer registry. Use the data sources when your artifact metadata is centralized in HCP. +page_title: HCP Packer Registry Data sources overview sidebar_title: Overview --- @@ -9,39 +9,31 @@ sidebar_title: Overview -# HCP Packer Registry Data sources +# HCP Packer Registry data sources overview -The HCP Packer Registry bridges the gap between artifact factories and artifact -deployments, allowing development and security teams to work together to create, +The HCP Packer Registry connects artifact factories and artifact +deployments so that development and security teams can work together to create, manage, and consume artifacts in a centralized way. +## Introduction + The HCP Packer Registry stores metadata about your artifacts, including when they -were created, where the artifacts exists in the cloud, and what (if any) git commit -is associated with your build. You can use the registry to track +were created, where the artifacts exists in the cloud, and git commit +information associated with your build. You can use the registry to track information about the artifacts your Packer builds produce, clearly designate which artifacts are appropriate for test and production environments, and query for the right artifacts to use in both Packer and Terraform configurations. -Packer has two data sources that work together to retrieve information from the +The following Packer data sources work together to determine and retrieve information from the HCP Packer registry: -- [hcp-packer-version](/packer/docs/datasources/hcp/hcp-packer-version) - -retrieves information about an HCP Packer Version in HCP Packer Registry -- [hcp-packer-artifact](/packer/docs/datasources/hcp/hcp-packer-artifact) - retrieves -information about a specific artifact created in the HCP Packer registry - -Deprecated data sources: (Please use above given data sources instead) -- [hcp-packer-iteration](/packer/docs/datasources/hcp/hcp-packer-iteration) - - retrieves information about an iteration in HCP Packer registry -- [hcp-packer-image](/packer/docs/datasources/hcp/hcp-packer-image) - retrieves - information about a specific image created in the HCP Packer registry - -These data sources are intended to be used together to determine source artifact -for pipelined Packer builds. +- [hcp-packer-version](/packer/docs/datasources/hcp/hcp-packer-version): Retrieves information about an HCP Packer version in the HCP Packer registry. +- [hcp-packer-artifact](/packer/docs/datasources/hcp/hcp-packer-artifact): Retrieves +information about a specific artifact created in the HCP Packer registry. -## How to use this plugin +The following data source types are deprecated since v1.10.1: -This plugin comes bundled with the Packer core, so you do not need to install -it separately. Please install Packer v1.7.7 or above to use the latest version -of the HCP Packer Registry data sources. +- [hcp-packer-iteration](/packer/docs/datasources/hcp/hcp-packer-iteration): Retrieves information about an iteration in HCP Packer registry. This data source type is deprecated. Use `hcp-packer-version` instead. +- [hcp-packer-image](/packer/docs/datasources/hcp/hcp-packer-image): Retrieves + information about a specific image created in the HCP Packer registry. This data source type is deprecated. Use `hcp-packer-artifact` instead. \ No newline at end of file diff --git a/website/content/docs/datasources/http.mdx b/website/content/docs/datasources/http.mdx index f11e5c64a85..3357d749ae4 100644 --- a/website/content/docs/datasources/http.mdx +++ b/website/content/docs/datasources/http.mdx @@ -1,8 +1,7 @@ --- description: | - The HTTP Data Source retrieves information from an HTTP endpoint to be used - during Packer builds -page_title: HTTP - Data Sources + The `http` data source makes an HTTP `GET` request to the specified URL and exports information about the response. +page_title: http data source reference --- @@ -10,11 +9,9 @@ page_title: HTTP - Data Sources -# HTTP Data Source +# `http` -Type: `http` - -The `http` data source makes an HTTP GET request to the given URL and exports information about the response. +The `http` data source makes an HTTP `GET` request to the specified URL and exports information about the response. ## Basic Example diff --git a/website/content/docs/datasources/index.mdx b/website/content/docs/datasources/index.mdx index cf70bde28cf..1bcf1c8ffa4 100644 --- a/website/content/docs/datasources/index.mdx +++ b/website/content/docs/datasources/index.mdx @@ -1,15 +1,14 @@ --- +page_title: Data sources overview description: | - Data sources allow data to be fetched for use in Packer configuration. Use of data sources - allows a build to use information defined outside of Packer. -page_title: Data Sources + A data source holds data you want to use in the Packer configuration. Define a data source in your configuration so that Packer can use external data during builds. --- -# Data Sources +# Data sources Data sources let Packer fetch data to use in a template, including information defined outside of Packer. Refer to the [`data`](/packer/docs/templates/hcl_templates/datasources) block documentation to learn more about working with data sources. The documentation also contains details about each type of data source. --> **Note:** Data sources is a feature exclusively available to HCL2 templates included in Packer `v1.7.0` (and newer). +Data sources are only available in HCL2 templates and require Packer `v1.7.0` and newer. diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 65ed0cb2dce..a4d8cc732b9 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -740,7 +740,7 @@ ] }, { - "title": "Data Sources", + "title": "Data sources reference", "routes": [ { "title": "Overview", @@ -754,25 +754,35 @@ "path": "datasources/hcp" }, { - "title": "Version", + "title": "hcp-packer-version", "path": "datasources/hcp/hcp-packer-version" }, { - "title": "Artifact", + "title": "hcp-packer-artifact", "path": "datasources/hcp/hcp-packer-artifact" }, { - "title": "Iteration", - "path": "datasources/hcp/hcp-packer-iteration" + "title": "hcp-packer-iteration", + "path": "datasources/hcp/hcp-packer-iteration", + "badge" : { + "text": "DEPRECATED", + "type": "outlined", + "color": "neutral" + } }, { - "title": "Image", - "path": "datasources/hcp/hcp-packer-image" + "title": "hcp-packer-image", + "path": "datasources/hcp/hcp-packer-image", + "badge" : { + "text": "DEPRECATED", + "type": "outlined", + "color": "neutral" + } } ] }, { - "title": "HTTP", + "title": "http", "path": "datasources/http" } ] From 9cf014fa0841823b1bc6a311bdc916f2fb278598 Mon Sep 17 00:00:00 2001 From: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Date: Fri, 24 Jan 2025 13:50:20 -0800 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Brian McClain --- website/content/docs/datasources/hcp/hcp-packer-image.mdx | 4 ++-- website/content/docs/datasources/hcp/hcp-packer-version.mdx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/website/content/docs/datasources/hcp/hcp-packer-image.mdx b/website/content/docs/datasources/hcp/hcp-packer-image.mdx index bab62a11361..afa38b2b12f 100644 --- a/website/content/docs/datasources/hcp/hcp-packer-image.mdx +++ b/website/content/docs/datasources/hcp/hcp-packer-image.mdx @@ -1,6 +1,6 @@ --- description: | - The `hcp-packer-image` data source retrieves information about an image from the HCP Packer registry. This data source has been deprecated, use the `hcp-packer-artifact` data source instead. + The `hcp-packer-image` data source retrieves information about an image from the HCP Packer registry. This data source is deprecated, use the `hcp-packer-artifact` data source instead. page_title: hcp-packer-image data source reference --- @@ -10,7 +10,7 @@ page_title: hcp-packer-image data source reference # `hcp-packer-image` -~> **This data source id deprecated**. Use the [`hcp-packer-artifact`](/packer/docs/datasources/hcp/hcp-packer-artifact) data source instead. +~> **This data source is deprecated**. Use the [`hcp-packer-artifact`](/packer/docs/datasources/hcp/hcp-packer-artifact) data source instead. The `hcp-packer-image` data source retrieves information about an image from the HCP Packer registry. This information can be used to diff --git a/website/content/docs/datasources/hcp/hcp-packer-version.mdx b/website/content/docs/datasources/hcp/hcp-packer-version.mdx index d9a250cb795..05a9d4b19fd 100644 --- a/website/content/docs/datasources/hcp/hcp-packer-version.mdx +++ b/website/content/docs/datasources/hcp/hcp-packer-version.mdx @@ -1,7 +1,7 @@ --- description: | The `hcp-packer-version` data source retrieves information about - the HCP Packer version from the HCP Packer registry. Use this information to + an HCP Packer version from the HCP Packer registry. Use this information to get a source's external identifier. page_title: hcp-packer-version data source reference --- @@ -14,7 +14,7 @@ page_title: hcp-packer-version data source reference # `hcp-packer-version` The `hcp-packer-version` dsata source retrieves information about -the HCP Packer version from the HCP Packer registry. You can use the version information to +an HCP Packer version from the HCP Packer registry. You can use the version information to query HCP for a source's external identifier so that you can use it in various Packer builders. To get started with HCP Packer, refer to the [HCP Packer documentation](/hcp/docs/packer) or try the