docs: fix confusing loopback IPs in environment setup#827
Open
jkomg wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently, the "Setup Environment" code block defines MACHINE_0_ADDRESS and MACHINE_1_ADDRESS using loopback addresses (127.0.0.1). This is causing confusion for developers who assume these are valid defaults or that the step applies to a local deployment. Furthermore, these variables are not used in the Secret generation block below them.
This PR updates the documentation to use explicit, non-routable documentation IP addresses (192.0.2.x) and adds a comment explicitly telling developers to replace them.
Changes to the Documentation Page
Change this:
Why this fix works better:
The Comment Flag: Adding # REPLACE THESE explicitly tells a developer scanning the code that action is required on their part.
RFC 5737 Documentation IPs: Using 192.0.2.X addresses is the industry standard for documentation. They are explicitly reserved for examples and are completely unroutable, meaning if a developer accidentally copy-pastes them, the script will instantly fail cleanly with a "network unreachable" or "timeout" error, rather than behaving strangely on localhost.