Skip to content
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

(aws-certificatemanager): Typo name in packages with hyphen (-) #33037

Open
peterpham opened this issue Jan 21, 2025 · 1 comment
Open

(aws-certificatemanager): Typo name in packages with hyphen (-) #33037

peterpham opened this issue Jan 21, 2025 · 1 comment
Labels
@aws-cdk/aws-certificatemanager Related to Amazon Certificate Manager documentation This is a problem with documentation. p2

Comments

@peterpham
Copy link

Describe the issue

Some TypeScript packages with - seems to be changed to _ on the public documentation

Example:
aws-certificatemanager --> aws_certificatemanager
aws-apigatewayv2 --> aws_apigatewayv2
aws-xray --> aws_xray

Source: https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib

Copy incorrect package name from the doc gave me error Cannot find module 'aws-cdk-lib/aws_certificatemanager' or its corresponding type declarations.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.CertificateValidation.html

@peterpham peterpham added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 21, 2025
@github-actions github-actions bot added the @aws-cdk/aws-certificatemanager Related to Amazon Certificate Manager label Jan 21, 2025
@pahud pahud self-assigned this Jan 22, 2025
@pahud
Copy link
Contributor

pahud commented Jan 22, 2025

Are you mentioning the package names in the side panel?
Makes sense to me since we are watching typescript document the package name should be consistent.
I'll bring this up to the team for further inputs.

Image

@pahud pahud removed their assignment Jan 22, 2025
@pahud pahud added p2 and removed needs-triage This issue or PR still needs to be triaged. labels Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-certificatemanager Related to Amazon Certificate Manager documentation This is a problem with documentation. p2
Projects
None yet
Development

No branches or pull requests

2 participants