Skip to content

97th Floor SEO optimization #2376

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

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions content/docs/intro/vs/cloud_templates.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Pulumi vs. Cloud Templates (AWS CloudFormation, etc.)
meta_desc: This page gives an overview of the major differences between Pulumi
and Cloud Templates (AWS CloudFormation, etc.).
title: Pulumi vs. AWS CloudFormation and Other Templates | Pulumi
Copy link
Member

@joeduffy joeduffy Feb 5, 2020

Choose a reason for hiding this comment

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

A while ago, we used to auto-append "| Pulumi" to all page titles. Is that worth bringing back?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's room for adjusting to suit your brand, as it's not a super important SEO issue, but Moz does recommend the "| Brand Name" format for title tags in Google; it looks good and keeps things uniform, so that's what we typically recommend.

Copy link
Contributor

Choose a reason for hiding this comment

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

In most cases (including this page), we do indeed append this automatically, yep:

image

https://github.com/pulumi/docs/blob/master/layouts/partials/head.html#L66-L71

(So there's no need to specify these manually in frontmatter titles, @97thFloor.)

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: Pulumi vs. AWS CloudFormation and Other Templates | Pulumi
title: Pulumi vs. AWS CloudFormation and Other Templates

meta_desc: This page gives an overview of the major differences between Pulumi and Cloud Templates such as AWS CloudFormation.
Copy link
Contributor

Choose a reason for hiding this comment

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

Caps are unnecessary, as cloud templates isn't a proper noun.

Suggested change
meta_desc: This page gives an overview of the major differences between Pulumi and Cloud Templates such as AWS CloudFormation.
meta_desc: This page gives an overview of the major differences between Pulumi and cloud templates such as AWS CloudFormation.

linktitle: Cloud Templates
menu:
intro:
Expand All @@ -11,18 +10,26 @@ menu:
aliases: ["/docs/reference/vs/cloud_templates/"]
---

What is Pulumi?
Copy link
Contributor

Choose a reason for hiding this comment

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

Leading off with what sounds like an ad for Pulumi doesn't seem like the right thing, here, since these pages are aimed at delivering comparative info, and they'd seem to be working relatively well in that regard. I'd remove these headings and this introductory section and leave these pages structurally as they are today, unless breaking them up is solving a problem that can't be solved otherwise.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It was mostly to get the "What is CloudFormation?" part in there, as that is the first snippet question on the SERP, and CloudFormation is the primary KW. The "What is Pulumi?" part was more to balance it out and provide a clearer structure, since this is a comparison page. Would it be ok to switch the order and lead with CloudFormation?


Pulumi offers a multi-cloud alternative to typical, more restrictive infrastructure-as-code template solutions, such as AWS CloudFormation. Pulumi allows you to streamline processes through managing resources from different platforms all in one place, using real code, in your favorite language.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Pulumi offers a multi-cloud alternative to typical, more restrictive infrastructure-as-code template solutions, such as AWS CloudFormation. Pulumi allows you to streamline processes through managing resources from different platforms all in one place, using real code, in your favorite language.
Pulumi offers a multi-cloud alternative to more restrictive infrastructure-as-code template solutions, such as AWS CloudFormation. Pulumi allows you to streamline processes through managing resources from different platforms all in one place, using real code, in your favorite language.


What is CloudFormation?

All major cloud providers offer their own form of infrastructure-as-"code" solution, typically by way of JSON or
YAML-based templating solutions. This includes AWS CloudFormation and Azure Resource Manager (ARM) templates.

These markup-based configuration files are often uploaded to a hosted service in the target cloud, where a hosted
service will then process the files to create, update, or delete resources as necessary.

The Pulumi Difference

Pulumi's model shares a lot with these systems. Although Pulumi programs are written in imperative, familiar languages,
they are ultimately evaluated to produce a similar set of create, update, or delete operations for your cloud resources.

This is where Pulumi begins to diverge from these other solutions, however.
This is where Pulumi begins to diverge from these other solutions such as AWS CloudFormation, however.
Copy link
Contributor

Choose a reason for hiding this comment

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

This feels stuck in, here. The sentence as a whole doesn't work with it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe "This is where Pulumi begins to diverge from solutions like AWS CloudFormation, however"?


Pulumi lets you use your favorite languages, instead of bespoke templating solutions. These typically use syntaxes that
Pulumi lets you use your favorite languages — complete control rather than bespoke templating solutions such as CloudFormation. These templates typically use syntaxes that
Copy link
Contributor

Choose a reason for hiding this comment

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

This sentence is no longer clear. Should the dash be a colon? And "complete control" and "bespoke templating solutions" are not directly comparable enough to be separated with a "rather than". (In other words, languages and templating solutions are comparable, as they're both technologies. Control is not a technology.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's probably fine to leave as is then, as long as we can still get the "CloudFormation" part in there.

are awkward, hard to learn, and even harder to remember. Pulumi programs are just real code. Thanks to basic things
like functions and classes, we've seen 25,000 line CloudFormation templates shrink to just a few hundred lines of code.
This approach also leads to far less copy and pasting between projects because you can share packages.
Expand All @@ -42,5 +49,5 @@ There are many community-led projects which allow you to write code in a real la
configuration templates as a sort of "compilation" step. These offer nice syntactic sugar on top of the raw
templates, but the underlying model leaks through and carries forward all of the other abovementioned shortcomings.

Finally, Pulumi is [open source](https://github.com/pulumi/pulumi) and community-driven. All of the cloud systems are
Finally, Pulumi is [open source](https://github.com/pulumi/pulumi) and community-driven. All of the other cloud systems — such as Azure Automation or AWS CloudFormation — are
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Finally, Pulumi is [open source](https://github.com/pulumi/pulumi) and community-driven. All of the other cloud systems — such as Azure Automation or AWS CloudFormation — are
Finally, Pulumi is [open source](https://github.com/pulumi/pulumi) and community-driven. All of the other cloud systems — such as Azure Resource Manager or AWS CloudFormation — are

proprietary closed source, lead to lock-in, and lack the ability for the community to contribute to them.