chore(docs): Add CDK for Terraform to page titles #2278
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
laurapacilio
requested review from
ansgarm and
DanielMSchmidt
and removed request for
a team
laurapacilio
changed the title
ansgarm
approved these changes
Nov 14, 2022
ansgarm
reviewed
Nov 14, 2022
|
I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently when folks google CDK for Terraform Concepts, it's impossible to tell whether some of the results are for regular Terraform or CDK for Terraform. This is because our content has a lot of similar concepts to Terraform (like providers) and every page is automatically appended with "- Terraform | HashiCorp Developer"
This makes it more difficult for users to be sure that they are getting the right content when they click on a page. This PR adds "CDK for Terraform" to every page title to make it clear which content relates to CDKTF specifically.
Examples
A provider page - this is for CDK for Terraform, but the title makes it look like it's for regular Terraform only.
Terraform Content uses "-Configuration Language" so we modeled the "- CDK for Terraform" after this for consistency.
Search for Terraform Functions yields two pages - one for configuration language and one for cdktf. But by the titles, it's incredibly difficult to know what's different about the second page (it's the one for CDKTF).