Description
Is there an existing issue for this?
- I have searched the existing issues
Current Behavior
I was reading the LocalStack Concepts Documentation And I found that some of the links were not working anymore.
I assume that there was a major refactoring at sometime ago and the path to the referenced file was changed.
e.g. the link to the utils.
I identified 5 broken links in this document.
-
Our protocol parser translates AWS HTTP requests into objects that can be used to call the respective function of the service provider.
-
Our protocol serializer translates response objects coming from service provider functions into HTTP responses.
-
The patch utility enables easy monkey patching of external functionality. We often use this to modify internal moto functionality. Sometimes it is easier to patch internals than to wrap the entire API method with the custom functionality.
-
Server is an abstract class that provides a basis for serving other backends that run in a separate process. For example, our Kinesis implementation uses kinesis-mock as a backend that implements the Kinesis AWS API and also emulates its behavior.
-
The utilities are grouped into multiple util modules inside the localstack.utils package. Some of the most commonly used utils modules include:
Their new location should be under the localstack-core folder... e.g. https://github.com/localstack/localstack/blob/master/localstack-core/localstack/aws/protocol/parser.py
There is one more link that might be out of date but it's not broken.
The LocalStack configuration is currently simply a set of well-known environment variables that we parse into python values in
localstack/config.py. When LocalStack is started via the CLI, we also need to pass those environment variables to the container, which is why we keep a list of the environment variables we consider to be LocalStack configuration.
I'm following up with a PR.
Expected Behavior
All the broken links of the documentation should point to the new locations. e.g. https://github.com/localstack/localstack/blob/master/localstack-core/localstack/aws/protocol/parser.py and not lead to 404 pages.
How are you starting LocalStack?
Custom (please describe below)
Steps To Reproduce
Visit LocalStack Concepts Readme.md file and try the links in the fragments mentioned in the description.
GitHub will respond with a 404 page.
Environment
- OS: MacOS 14.6.1 (23G93)
- LocalStack:
LocalStack version: 0.1.dev6454Anything else?
No response