aws-proxy: remove source code, keep README with PyPI install instructions#134
Conversation
…ions Code has moved elsewhere; the extension directory now contains only a README pointing users to install via `localstack extensions install`. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
| ======================================== | ||
| AWS Cloud Proxy Extension | ||
| ========================= | ||
| [](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-aws-proxy&subdirectory=aws-proxy) |
There was a problem hiding this comment.
Not sure about the impact on the console side, but this link still points to this repository. Is it expected?
| ## Installation | ||
|
|
||
| The AWS Cloud Proxy can be used to forward certain API calls in LocalStack to real AWS, in order to enable seamless transition between local and remote resources. | ||
| Install the extension via the LocalStack CLI: |
There was a problem hiding this comment.
follow-up: would it make sense to move these instructions entirely to our docs and point our users there ? That way we will have a single source of truth on how to run the extension and we won't need to change anything here again.
There was a problem hiding this comment.
Great point - /cc @quetzalliwrites @HarshCasper wdyt, would it make sense to point our users to the docs directly here?
There was a problem hiding this comment.
Hola @whummer @nik-localstack, I agree, it's a great idea to point to the docs here.Like @nik-localstack says, this way you don't need to maintain it in multiple places 🙌🏽
There was a problem hiding this comment.
Done @quetzalliwrites - added a link to this tutorial in our docs: https://docs.localstack.cloud/aws/tutorials/aws-proxy-localstack-extension/ I've left the basic installation steps and configuration options in the README here for now, though, as it seems in the docs currently we only have the tutorial, but not a full documentation of this extension with all config options, etc.
Perhaps there could be an opportunity to review the current docs coverage for our Extensions more holistically..? (we've recently also added some new extensions recently, and I don't think all of them are centrally documented yet.) Happy to discuss offline! 👍
There was a problem hiding this comment.
Oooh got it, thank you for pointing out we can improve extensions docs. I will create a ticket Monday morning and follow up 🎟️🌈 @whummer
The install badge linked to the GitHub source which no longer exists; replaced with a link to the official docs tutorial as the single source of truth for getting started, while keeping the inline reference docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
3 participants
Summary
aws-proxyextension (code has moved elsewhere)README.mdwith simplified installation instructions pointing to PyPI (localstack extensions install localstack-extension-aws-proxy)aws_proxy/,tests/,example/,etc/,pyproject.toml,Makefile,MANIFEST.in,AGENTS.mdTest plan
aws-proxy/README.mdis the only remaining tracked file in the directory