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

(docs): Broken links are scattered throughout docs following repo restructure #24958

Open
yo-ga opened this issue Apr 5, 2023 · 6 comments
Open
Labels
bug This issue is a bug. documentation This is a problem with documentation. effort/medium Medium work item – several days of effort p2

Comments

@yo-ga
Copy link
Contributor

yo-ga commented Apr 5, 2023

Describe the issue

After the related remodeling task, the integration testing document isn't updated.
It makes the developers confused and hard to follow.

Links

INTEGRATION_TESTS.md

@yo-ga yo-ga added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Apr 5, 2023
@peterwoodworth
Copy link
Contributor

I've been having some issues with our documentation in general since the change, lots of broken links everywhere! i'm going to use this issue to consolidate all broken links if that's okay with you 🙂

@peterwoodworth peterwoodworth changed the title (contributing): The content of integration testing document isn't stable after remodeling (docs): Broken links are scattered throughout docs following repo restructure Apr 5, 2023
@peterwoodworth peterwoodworth added p1 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Apr 5, 2023
@peterwoodworth peterwoodworth removed their assignment Apr 5, 2023
@peterwoodworth peterwoodworth added the bug This issue is a bug. label Apr 5, 2023
@yo-ga
Copy link
Contributor Author

yo-ga commented Apr 5, 2023

@peterwoodworth Any will do.

@plumdog
Copy link
Contributor

plumdog commented Apr 6, 2023

Main thing I've hit is the links from the main docs that link to the source code, eg:
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html

Which has a "(source)" link next to "TypeScript". This links to https:/aws/aws-cdk/blob/v2.73.0/packages/@aws-cdk/aws-s3/lib/bucket.ts#L1623, the old location in the repo. (This location existed as of 2.72.0 but is now gone).

Edit: I should add, strictly, this is tied to the 2.73.0 release (which contained the restructure) rather than to the restructure itself, as the "source" links reference the latest release's tag on GitHub.

@yo-ga
Copy link
Contributor Author

yo-ga commented Apr 7, 2023

Actually, this original scope is more likely the same as the meaning for the label docs/repo-general.
@peterwoodworth If you are like to collect and track the whole documented issues, here the better way is.
You create the tracking issue on your own. After doing that, you link the issues, including this one.

@peterwoodworth
Copy link
Contributor

Also this issue #26037

@peterwoodworth
Copy link
Contributor

#26662

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. documentation This is a problem with documentation. effort/medium Medium work item – several days of effort p2
Projects
None yet
Development

No branches or pull requests

4 participants