Style and SEO updates #3775
Open
Style and SEO updates #3775
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
…ide and optimize for SEO
robin-norwood
requested review from
BrianMMcClain,
ritsok,
rkoron007 and
trujillo-adam
robin-norwood
requested review from
mutahhir and
ansgarm
and removed request for
a team
DanielMSchmidt
approved these changes
Nov 25, 2024
rkoron007
approved these changes
Dec 2, 2024
| @@ -1,9 +1,11 @@ | |||
| --- | |||
| page_title: C# API resource reference overview | |||
| description: Learn about the API resources available in the Terraform CDK library for C#. | |||
| page_title: CDKTF C# API resource reference overview | |||
There was a problem hiding this comment.
Suggested change
| page_title: CDKTF C# API resource reference overview | |
| page_title: CDKTF C# API resource reference |
| description: Learn about the API resources available in the Terraform CDK library for golang. | ||
| page_title: Go TypeScript API reference overview | ||
| description: >- | ||
| Use the Terraform CDK library for Go to define your CDK for Terraform application. |
There was a problem hiding this comment.
I think we can omit "application"?
Suggested change
| Use the Terraform CDK library for Go to define your CDK for Terraform application. | |
| Use the Terraform CDK library for Go to define your CDK for Terraform. |
| @@ -1,9 +1,10 @@ | |||
| --- | |||
| page_title: Go API resource reference overview | |||
| description: Learn about the API resources available in the Terraform CDK library for golang. | |||
| page_title: Go TypeScript API reference overview | |||
There was a problem hiding this comment.
Suggested change
| page_title: Go TypeScript API reference overview | |
| page_title: Go TypeScript API overview |
| --- | ||
|
|
||
| # Go API resource reference overview | ||
| # CDKTF Go API reference overview |
There was a problem hiding this comment.
I think we can stick with just "overview" here:
Suggested change
| # CDKTF Go API reference overview | |
| # CDKTF Go API overview |
| @@ -1,10 +1,12 @@ | |||
| --- | |||
| page_title: API Reference - CDKTF Core Library | |||
| page_title: CDKTF core library API Reference | |||
There was a problem hiding this comment.
Suggested change
| page_title: CDKTF core library API Reference | |
| page_title: CDKTF core library API reference |
| --- | ||
|
|
||
| # Synthesization Performance | ||
| # Synthesization performance |
There was a problem hiding this comment.
Suggested change
| # Synthesization performance | |
| # Optimize performance for CDKTF |
| @@ -1,9 +1,11 @@ | |||
| --- | |||
| page_title: Performance - CDK for Terraform | |||
| description: The faster you can synthesize your CDKTF code, the faster you can deploy it. Learn how to optimize your CDK for Terraform performance. | |||
| page_title: Performance | |||
There was a problem hiding this comment.
Suggested change
| page_title: Performance | |
| page_title: Optimize performance for CDKTF |
| @@ -1,11 +1,11 @@ | |||
| --- | |||
| page_title: Project Setup - CDK for Terraform | |||
| page_title: Project setup | |||
There was a problem hiding this comment.
Suggested change
| page_title: Project setup | |
| page_title: Set up a new CDK for Terraform new project |
| @@ -1,11 +1,11 @@ | |||
| --- | |||
| page_title: Remote Templates - CDK for Terraform | |||
| page_title: Remote templates | |||
There was a problem hiding this comment.
Suggested change
| page_title: Remote templates | |
| page_title: Remote templates with CDK for Terraform |
| page_title: Construct Design | CDK for Terraform | ||
| description: |- | ||
| Write highly configurable construct classes that provide guidance for a wide range of use cases. | ||
| page_title: Design constructs |
There was a problem hiding this comment.
Suggested change
| page_title: Design constructs | |
| page_title: Design CDKTF constructs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update titles, descriptions, and page headers to comply with style guide and optimize for SEO
Related issue
IPE-982
Description
This updates the CDKTF documentation per our style guide and SEO optimization guidelines.
Checklist