Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/packer seo functions batch3 #13284

Merged

Conversation

trujillo-adam
Copy link
Contributor

This PR refreshes meta descriptions and titles for content in the /hcl_templates /functions folder to improve SEO.

@trujillo-adam trujillo-adam requested review from a team as code owners January 29, 2025 18:23
@trujillo-adam trujillo-adam requested review from rmainwork and removed request for a team January 29, 2025 18:23
Copy link
Contributor

@judithpatudith judithpatudith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of the "Learn how to..." summaries in these, would we want to note the other types of information users will find on the page? For example I looked at the first few, and it seems like these pages contain "examples" (which I bet lots of people will google for) and relationships to other functions?

@trujillo-adam
Copy link
Contributor Author

trujillo-adam commented Jan 29, 2025

Instead of the "Learn how to..." summaries in these, would we want to note the other types of information users will find on the page? For example I looked at the first few, and it seems like these pages contain "examples" (which I bet lots of people will google for) and relationships to other functions?

You are correct that people also search for "examples of . . .". I went for the phrase "how to . . . " because that is usually a stronger initial search phrase. Trying to do too much in meta descriptions usually dilutes the discoverability. It's better to focus on either "examples of . . . " or "how to . . . "

Either way, the main keywords we are optimizing for is the function names, which means that searchers would already have to know the name of the function they are Googling. It's kind of a catch-22, though, because if they know the function name, they will definitely land on these pages regardless of the secondary "how to" or "examples of" phrase. But they would have to know the name of the function.

@judithpatudith
Copy link
Contributor

My only worry here is helping users land on the right content type. If someone is looking for a how-to and they land on these pages they might be sad, and if we add how-to pages in the future, including "how to" in these descriptions might make it harder for users to find the right thing. Functionally it probably doesn't matter a ton now though!

@trujillo-adam trujillo-adam merged commit c310eac into docs/packer-seo-fy2025q4 Jan 30, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants