Skip to content

chore: add comments to docs #3863

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

LeahMarieBush
Copy link

@LeahMarieBush LeahMarieBush commented Apr 29, 2025

Description

We are migrating the terraform-cdk documentation to a unified HashiCorp product documentation repository. As a result of this migration, the unified repo (web-unified-docs) will be the source of truth.

This PR adds a notice to all existing MDX files in the original location so folks know where to contribute. We plan on deprecating and removing the files in /website.

This PR will be merged after docs have been migrated

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

@LeahMarieBush
Copy link
Author

Hello! I'm not familiar with the tests that run on these PRs but I don't think my changes would cause integration test failures. Can someone who is more familiar with this repo help me debug this to unblock this PR?

@mutahhir mutahhir enabled auto-merge May 7, 2025 09:49
@mutahhir mutahhir added this pull request to the merge queue May 7, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 7, 2025
@mutahhir mutahhir added this pull request to the merge queue May 7, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 7, 2025
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.

2 participants