aws / aws/aws-cdk

cfnspec: Broken link in L1 resource documentation

Open
#24,273 1 comment 1 reaction 0 assignees View on GitHub
@aws-cdk/cfnspec bug documentation effort/small needs-cfn p3
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the issue

# What
There is a broken link labelled "Sharing with IAM roles and users" linking to "https://ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types" on the ram documentation page https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ram.CfnResourceShare.html.

# Other considerations
Considering this seems like this could be a more common issue considering a very similar issue was found with another CFN sourced link was opened earlier [here](https://github.com/aws/aws-cdk/issues/24054) it might be worth re raising this a wider ticket to check all the documentation derived from the CF docs to check for and then fix dead links due to double slashes (//) being in the URL or other reasons :thinking:

### Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ram.CfnResourceShare.html

Contributor guide

Open the contributing guide

Research direction

Open the linked CfnResourceShare documentation page and verify the broken “Sharing with IAM roles and users” URL. Compare it with issue #24054 to understand the related generated-link problem, then identify the documentation source responsible for this link. Done means the link resolves correctly and any broader scope is explicitly defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.