From 276bf72fc1d2e2948b4fef6cd0e9e3e492b418ee Mon Sep 17 00:00:00 2001
From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Date: Fri, 16 Aug 2024 16:52:53 -0400
Subject: [PATCH 1/2] docs: Update `base64gzip` reference doc

Docs Day project
---
 .../docs/language/functions/base64gzip.mdx    | 65 +++++++++++++------
 1 file changed, 45 insertions(+), 20 deletions(-)

diff --git a/website/docs/language/functions/base64gzip.mdx b/website/docs/language/functions/base64gzip.mdx
index 2620e20f5d..ce90c1fec9 100644
--- a/website/docs/language/functions/base64gzip.mdx
+++ b/website/docs/language/functions/base64gzip.mdx
@@ -1,31 +1,56 @@
 ---
-page_title: base64gzip - Functions - Configuration Language
+page_title: base64gzip function reference - Functions - Configuration Language
 description: |-
-  The base64encode function compresses the given string with gzip and then
-  encodes the result in Base64.
+  The base64encode function compresses an HCL string using gzip, and then encodes it using Base64 encoding.
 ---
 
-# `base64gzip` Function
+# `base64gzip` function reference
 
-`base64gzip` compresses a string with gzip and then encodes the result in
-Base64 encoding.
+This topic provides reference information about the `base64gzip` function.
+The `base64gzip` function compresses an HCL string using gzip and then encodes the string using Base64 encoding.
 
-Terraform uses the "standard" Base64 alphabet as defined in
-[RFC 4648 section 4](https://tools.ietf.org/html/rfc4648#section-4).
+## Introduction
 
-Strings in the Terraform language are sequences of unicode characters rather
-than bytes, so this function will first encode the characters from the string
-as UTF-8, then apply gzip compression, and then finally apply Base64 encoding.
+You can use the `base64gzip` function to compress an HCL string and then encode it in the Base64 format.
+Terraform uses the standard Base64 alphabet that is defined in [RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648#section-4).
 
-While we do not recommend manipulating large, raw binary data in the Terraform
-language, this function can be used to compress reasonably sized text strings
-generated within the Terraform language. For example, the result of this
-function can be used to create a compressed object in Amazon S3 as part of
-an S3 website.
+While HashiCorp does not recommend manipulating large, raw binary data in HCL, Base64 encoding can be an effective way to represent small binary objects in memory when you need to pass them as values, rather than referring to files on disk.
+For example, you could use the `base64gzip` function to compress a large JSON string so that you can upload it to S3.
+
+Because HCL strings are sequences of unicode characters rather than bytes, `base64gzip` first encodes the characters in the string as UTF-8.
+Then it applies gzip compression and encodes the string using Base64 format.
+
+## Syntax
+
+Use the `base64gzip` function with the following syntax:
+
+```hcl
+base64gzip(ARGS)
+```
+
+The argument is the string that you want to compress and encode.
+
+In the following example, the function compresses the string at `local.my_data` and encodes it using the Base64 format.
+
+```hcl
+base64gzip(local.my_data)
+```
+
+## Example use case
+
+The following example defines a local value `my_data` that contains the string you want to compress and encode.
+The `base64gzip` function compresses and encodes the string, and then it is used to populate an S3 bucket.
+
+```hcl
+resource "aws_s3_object" "example" {
+  bucket = "my_bucket"
+  key = "example.txt"
+  content_base64 = base64gzip(local.my_data)
+  content_encoding = "gzip"
+}
+```
 
 ## Related Functions
 
-* [`base64encode`](/terraform/language/functions/base64encode) applies Base64 encoding _without_
-  gzip compression.
-* [`filebase64`](/terraform/language/functions/filebase64) reads a file from the local filesystem
-  and returns its raw bytes with Base64 encoding.
+* [`base64encode`](/terraform/language/functions/base64encode) applies Base64 encoding to an HCL string without using gzip compression.
+* [`filebase64`](/terraform/language/functions/filebase64) reads a file from the local filesystem and encodes its raw bits using the Base64 format.

From 580d3afb34633ee558b54a5604ca89fd032ca2ee Mon Sep 17 00:00:00 2001
From: Tu Nguyen <im2nguyen@users.noreply.github.com>
Date: Fri, 16 Aug 2024 15:54:51 -0700
Subject: [PATCH 2/2] Update website/docs/language/functions/base64gzip.mdx

---
 website/docs/language/functions/base64gzip.mdx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/website/docs/language/functions/base64gzip.mdx b/website/docs/language/functions/base64gzip.mdx
index ce90c1fec9..66fe36e03f 100644
--- a/website/docs/language/functions/base64gzip.mdx
+++ b/website/docs/language/functions/base64gzip.mdx
@@ -50,7 +50,7 @@ resource "aws_s3_object" "example" {
 }
 ```
 
-## Related Functions
+## Related functions
 
 * [`base64encode`](/terraform/language/functions/base64encode) applies Base64 encoding to an HCL string without using gzip compression.
 * [`filebase64`](/terraform/language/functions/filebase64) reads a file from the local filesystem and encodes its raw bits using the Base64 format.