aws / aws/aws-cdk

(ec2.CfnNetworkAclEntry): Invalid links to CloudFormation documentation

Open
#27,171 2 comments 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-ec2 @aws-cdk/cfnspec bug documentation effort/small p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
71

Description

### Describe the issue

The CloudFormation documentation links embedded in the ec2.CfnNetworkAclEntry seem to be invalid and redirect to user guide page of Cloudformation.

class CfnNetworkAclEntry (construct) · AWS CDK
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnNetworkAclEntry.html

Example link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-networkaclid

The correct link should be like this:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-networkaclid

### Links

class CfnNetworkAclEntry (construct) · AWS CDK
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnNetworkAclEntry.html

Contributor guide

Open the contributing guide

Research direction

Start from the CfnNetworkAclEntry documentation page and inspect the CloudFormation link shown for NetworkAclId. Compare it with the corrected aws-resource-ec2-network-acl-entry.html URL in the issue; done means the generated documentation link resolves to that page and preserves the anchor.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud, infrastructure
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.