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: GitHub source link on API Documentation #31509

Open
2 tasks
dontirun opened this issue Sep 20, 2024 · 3 comments
Open
2 tasks

docs: GitHub source link on API Documentation #31509

dontirun opened this issue Sep 20, 2024 · 3 comments
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p3

Comments

@dontirun
Copy link
Contributor

Describe the feature

Individual Each library (s3, ec2, lambda, etc) has a link to where that libraries code is defined in the aws-cdk GitHub Repo

Use Case

It make's it easier to troubleshoot/understand behavior of the construct and its properties. I often find myself manually searching the GitHub repo to do this and it can be tedious to do so.

Proposed Solution

No response

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.144.0 (build 5fb15bc)

Environment details (OS name and version, etc.)

mac os

@dontirun dontirun added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Sep 20, 2024
@pahud pahud added p3 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Sep 20, 2024
@pahud
Copy link
Contributor

pahud commented Sep 20, 2024

Have you tried class with className in the GitHub search box like if you need to check the ScalableTarget construct implementation but you're not sure which module it belongs to, simply type "class ScalableTarget" and hit enter in the GitHub search box. The first result would always be what you need:

image

then hit the link of the first result:
image

You will immediately get redirected to the first line of that class:

image

And this works for all classes in the whole repository on GitHub. Just a few seconds. For me, it's even easier than searching that in the API reference doc.

@pahud pahud added the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Sep 20, 2024
@dontirun
Copy link
Contributor Author

Nice, thank you! That makes searching a lot easier. While I still think a link to the source would be helpful, I think this a good "interim" solution

@pahud
Copy link
Contributor

pahud commented Sep 20, 2024

I am leaving this feat request open and we welcome community to help us prioritize with 👍 . Thank you and we love sharing all the interesting tips like this.

@pahud pahud removed the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p3
Projects
None yet
Development

No branches or pull requests

4 participants