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.

Sign up for GitHub

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

Jump to bottom

incorrect links to Java docs #27228

Closed
rittneje opened this issue Sep 20, 2023 · 4 comments
Closed

incorrect links to Java docs #27228

rittneje opened this issue Sep 20, 2023 · 4 comments
Assignees
@vinayak-kukreja
Labels
@aws-cdk/aws-s3 Related to Amazon S3 @aws-cdk/core Related to core CDK functionality bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort jsii This issue originates in jsii, or this feature must be implemented in jsii. p1 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.

Comments

@rittneje
Copy link

Describe the issue

The main docs are generating incorrect links to the Java docs.

For example, Bucket incorrectly links to https://docs.aws.amazon.com/cdk/api/v2/java/index.html?software/amazon/awscdk/services/s3/Bucket.html instead of https://docs.aws.amazon.com/cdk/api/v2/java/software/amazon/awscdk/services/s3/Bucket.html.

This problem is pervasive, so it seems more like some auto-generation problem than a one-off issue.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.Table.html

to name a few
@rittneje rittneje added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Sep 20, 2023
@github-actions github-actions bot added the @aws-cdk/aws-s3 Related to Amazon S3 label Sep 20, 2023
@peterwoodworth peterwoodworth added p1 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Sep 20, 2023
@peterwoodworth
Copy link
Contributor

Thanks, can confirm

@github-actions github-actions bot mentioned this issue Oct 1, 2023
Closed
@peterwoodworth peterwoodworth mentioned this issue Oct 6, 2023
Closed
@pahud pahud added jsii This issue originates in jsii, or this feature must be implemented in jsii. @aws-cdk/core Related to core CDK functionality bug This issue is a bug. labels Mar 14, 2024
@vinayak-kukreja vinayak-kukreja self-assigned this May 7, 2024
@vinayak-kukreja
Copy link
Contributor

Hey @rittneje , I believe the links are fixed now. Can you please confirm if the issue still persists for you?

@vinayak-kukreja vinayak-kukreja added the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label May 7, 2024
@rittneje
Copy link
Author

rittneje commented May 7, 2024

Yep, seems to be fixed.

@rittneje rittneje closed this as completed May 7, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented May 7, 2024

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vinayak-kukreja vinayak-kukreja

Labels
@aws-cdk/aws-s3 Related to Amazon S3 @aws-cdk/core Related to core CDK functionality bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort jsii This issue originates in jsii, or this feature must be implemented in jsii. p1 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@pahud @rittneje @peterwoodworth @vinayak-kukreja