Skip to content

chore: Style and SEO updates #3775

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

chore: Style and SEO updates #3775

wants to merge 19 commits into from
+224 −183

Conversation

robin-norwood
Copy link
Collaborator

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

  • I have updated the PR title to match CDKTF's style guide
  • I have run the linter on my code locally
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation if applicable
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works if applicable
  • New and existing unit tests pass locally with my changes

@robin-norwood robin-norwood requested review from a team as code owners November 22, 2024 21:17
@robin-norwood robin-norwood requested review from mutahhir and ansgarm and removed request for a team November 22, 2024 21:17
rkoron007
rkoron007 approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

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

Looks good! Left suggestions for ensuring consistency across title and h1s, but feel free to ignore anything that doesn't feel good!

@robin-norwood @rkoron007
Apply suggestions from code review
a5843ca 
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
@robin-norwood robin-norwood requested a review from a team as a code owner January 6, 2025 16:23
@robin-norwood robin-norwood requested review from heatlikeheatwave and removed request for a team January 6, 2025 16:23
@robin-norwood robin-norwood changed the title Style and SEO updates chore: Style and SEO updates Jan 7, 2025
@robin-norwood @heatlikeheatwave
Update website/docs/cdktf/cli-reference/commands.mdx
e174b6b 
Co-authored-by: Heat Hamilton <55773810+heatlikeheatwave@users.noreply.github.com>
@robin-norwood @heatlikeheatwave
Apply suggestions from code review
3d63369 
Co-authored-by: Heat Hamilton <55773810+heatlikeheatwave@users.noreply.github.com>
@github-actions GitHub Actions
Copy link
Contributor

Hi there! 👋 We haven't heard from you in 60 days and would like to know if you're still working on this or need help. If we don't hear from you before then, I'll auto-close this PR in 30 days.

@github-actions github-actions bot added the stale An issue or pull request that has not been updated in a very long time label Mar 19, 2025
@xiehan xiehan mentioned this pull request Apr 16, 2025
Closed
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@rkoron007 rkoron007 rkoron007 approved these changes

@BrianMMcClain BrianMMcClain Awaiting requested review from BrianMMcClain

@ritsok ritsok Awaiting requested review from ritsok

@trujillo-adam trujillo-adam Awaiting requested review from trujillo-adam

@mutahhir mutahhir Awaiting requested review from mutahhir mutahhir is a code owner automatically assigned from hashicorp/cdktf

@ansgarm ansgarm Awaiting requested review from ansgarm ansgarm is a code owner automatically assigned from hashicorp/cdktf

@DanielMSchmidt DanielMSchmidt Awaiting requested review from DanielMSchmidt

@heatlikeheatwave heatlikeheatwave Awaiting requested review from heatlikeheatwave

Assignees
No one assigned
Labels
stale An issue or pull request that has not been updated in a very long time
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@robin-norwood @DanielMSchmidt @rkoron007 @heatlikeheatwave