docs: enhance dev container documentation with comprehensive setup guide#40763
Merged
phlax merged 3 commits intoenvoyproxy:mainfrom Aug 21, 2025
prashanthjos:feature/improve-devcontainer-docs
Merged
docs: enhance dev container documentation with comprehensive setup guide#40763phlax merged 3 commits intoenvoyproxy:mainfrom prashanthjos:feature/improve-devcontainer-docs
phlax merged 3 commits intoenvoyproxy:mainfrom
prashanthjos:feature/improve-devcontainer-docs
Conversation
Add detailed step-by-step guide for setting up Envoy local development environment using VSCode/Cursor dev containers. The guide includes: - Complete prerequisites and system requirements - Troubleshooting section for Docker Desktop issues - Debug configuration with LLDB setup for macOS compatibility - Visual examples with image placeholders for key setup steps - Verification steps for successful Envoy startup - Key file locations and development workflow This addresses the gap in comprehensive documentation for developers who are not C++ experts and provides a complete walkthrough from initial setup to debugging Envoy source code locally. Tested on Apple M1 Max and Intel Core i9 machines running macOS Sequoia (version 15.5). Signed-off-by: Prashanth Jos <prashanthjos@gmail.com> Signed-off-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com>
Add screenshot images to support the comprehensive setup guide: - Docker Desktop configuration and error handling - Debug configuration with GDB and LLDB - Breakpoint setup and debugging workflow - Admin interface and endpoint verification - Container status and build success indicators These images provide visual context for the step-by-step setup process and help users verify their configuration at each stage. Signed-off-by: Prashanth Jos <prashanthjos@gmail.com> Signed-off-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com>
|
Docs for this Pull Request will be rendered here: https://storage.googleapis.com/envoy-cncf-pr/40763/docs/index.html The docs are (re-)rendered each time the CI |
Fix trailing whitespace and formatting issues detected by glint checker to comply with Envoy's code formatting standards. Signed-off-by: Prashanth Jos <prashanthjos@gmail.com> Signed-off-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com>
Contributor
Author
|
@phlax can you please help with the review. |
phlax
reviewed
Aug 21, 2025
Member
phlax
left a comment
There was a problem hiding this comment.
thanks for adding this thorough documentation @prashanthjos
as mentioned offline - i dont use vscode, same with docker desktop and mac or windows so would be good to get signoff from someone more familiar with these
overall looks like a welcome addition to our dev docs
phlax
approved these changes
Aug 21, 2025
Member
phlax
left a comment
There was a problem hiding this comment.
... actually lets just land it - we can iterate as needed
lgtm, thanks @prashanthjos
melginaldi
pushed a commit
to melginaldi/envoy
that referenced
this pull request
Aug 21, 2025
…ide (envoyproxy#40763) Add detailed step-by-step guide for setting up Envoy local development environment using VSCode/Cursor dev containers. The guide includes: - Complete prerequisites and system requirements - Troubleshooting section for Docker Desktop issues - Debug configuration with LLDB setup for macOS compatibility - Visual examples with image placeholders for key setup steps - Verification steps for successful Envoy startup - Key file locations and development workflow This addresses the gap in comprehensive documentation for developers who are not C++ experts and provides a complete walkthrough from initial setup to debugging Envoy source code locally. Tested on Apple M1 Max and Intel Core i9 machines running macOS Sequoia (version 15.5). Additional Description: This PR significantly enhances the existing dev container documentation by adding a comprehensive setup guide that walks through the entire process from repository cloning to successful debugging. The original documentation was brief and referenced external guides, but this enhancement provides a complete, self-contained walkthrough with troubleshooting solutions for common issues encountered during setup. The guide is particularly valuable for developers who are not C++ experts and may be unfamiliar with Bazel build systems. It includes visual documentation with 16 screenshot images showing key steps and verification points. Risk Level: Low Testing: - Manually tested complete setup process on Apple M1 Max and Intel Core i9 machines - Verified on macOS Sequoia (version 15.5) - Tested with both VSCode and Cursor IDEs - Validated all Docker Desktop configuration steps - Confirmed LLDB debugger setup and functionality - Verified all admin endpoints and proxy functionality - All pre-push validation checks passed Docs Changes: Enhanced .devcontainer/README.md with comprehensive setup guide including: - Detailed step-by-step instructions - Troubleshooting section for Docker Desktop issues - Debug configuration with both GDB and LLDB options - Visual documentation with 16 supporting images - Complete verification steps - Development workflow guidelines Release Notes: N/A Platform Specific Features: N/A - Documentation changes only, though the guide specifically addresses macOS compatibility issues with debugger configuration. --------- Signed-off-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com> Co-authored-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com> Signed-off-by: Melissa Ginaldi <mginaldi@google.com>
melginaldi
pushed a commit
to melginaldi/envoy
that referenced
this pull request
Aug 26, 2025
…ide (envoyproxy#40763) Add detailed step-by-step guide for setting up Envoy local development environment using VSCode/Cursor dev containers. The guide includes: - Complete prerequisites and system requirements - Troubleshooting section for Docker Desktop issues - Debug configuration with LLDB setup for macOS compatibility - Visual examples with image placeholders for key setup steps - Verification steps for successful Envoy startup - Key file locations and development workflow This addresses the gap in comprehensive documentation for developers who are not C++ experts and provides a complete walkthrough from initial setup to debugging Envoy source code locally. Tested on Apple M1 Max and Intel Core i9 machines running macOS Sequoia (version 15.5). Additional Description: This PR significantly enhances the existing dev container documentation by adding a comprehensive setup guide that walks through the entire process from repository cloning to successful debugging. The original documentation was brief and referenced external guides, but this enhancement provides a complete, self-contained walkthrough with troubleshooting solutions for common issues encountered during setup. The guide is particularly valuable for developers who are not C++ experts and may be unfamiliar with Bazel build systems. It includes visual documentation with 16 screenshot images showing key steps and verification points. Risk Level: Low Testing: - Manually tested complete setup process on Apple M1 Max and Intel Core i9 machines - Verified on macOS Sequoia (version 15.5) - Tested with both VSCode and Cursor IDEs - Validated all Docker Desktop configuration steps - Confirmed LLDB debugger setup and functionality - Verified all admin endpoints and proxy functionality - All pre-push validation checks passed Docs Changes: Enhanced .devcontainer/README.md with comprehensive setup guide including: - Detailed step-by-step instructions - Troubleshooting section for Docker Desktop issues - Debug configuration with both GDB and LLDB options - Visual documentation with 16 supporting images - Complete verification steps - Development workflow guidelines Release Notes: N/A Platform Specific Features: N/A - Documentation changes only, though the guide specifically addresses macOS compatibility issues with debugger configuration. --------- Signed-off-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com> Co-authored-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com> Signed-off-by: Melissa Ginaldi <mginaldi@google.com>
wtzhang23
pushed a commit
to wtzhang23/envoy
that referenced
this pull request
Aug 27, 2025
…ide (envoyproxy#40763) Add detailed step-by-step guide for setting up Envoy local development environment using VSCode/Cursor dev containers. The guide includes: - Complete prerequisites and system requirements - Troubleshooting section for Docker Desktop issues - Debug configuration with LLDB setup for macOS compatibility - Visual examples with image placeholders for key setup steps - Verification steps for successful Envoy startup - Key file locations and development workflow This addresses the gap in comprehensive documentation for developers who are not C++ experts and provides a complete walkthrough from initial setup to debugging Envoy source code locally. Tested on Apple M1 Max and Intel Core i9 machines running macOS Sequoia (version 15.5). Additional Description: This PR significantly enhances the existing dev container documentation by adding a comprehensive setup guide that walks through the entire process from repository cloning to successful debugging. The original documentation was brief and referenced external guides, but this enhancement provides a complete, self-contained walkthrough with troubleshooting solutions for common issues encountered during setup. The guide is particularly valuable for developers who are not C++ experts and may be unfamiliar with Bazel build systems. It includes visual documentation with 16 screenshot images showing key steps and verification points. Risk Level: Low Testing: - Manually tested complete setup process on Apple M1 Max and Intel Core i9 machines - Verified on macOS Sequoia (version 15.5) - Tested with both VSCode and Cursor IDEs - Validated all Docker Desktop configuration steps - Confirmed LLDB debugger setup and functionality - Verified all admin endpoints and proxy functionality - All pre-push validation checks passed Docs Changes: Enhanced .devcontainer/README.md with comprehensive setup guide including: - Detailed step-by-step instructions - Troubleshooting section for Docker Desktop issues - Debug configuration with both GDB and LLDB options - Visual documentation with 16 supporting images - Complete verification steps - Development workflow guidelines Release Notes: N/A Platform Specific Features: N/A - Documentation changes only, though the guide specifically addresses macOS compatibility issues with debugger configuration. --------- Signed-off-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com> Co-authored-by: prashanth.chaitanya <prashanth.chaitanya@salesforce.com>
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
3 participants
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.
Commit Message: docs: enhance dev container documentation with comprehensive setup guide
Add detailed step-by-step guide for setting up Envoy local development
environment using VSCode/Cursor dev containers. The guide includes:
This addresses the gap in comprehensive documentation for developers
who are not C++ experts and provides a complete walkthrough from
initial setup to debugging Envoy source code locally.
Tested on Apple M1 Max and Intel Core i9 machines running macOS
Sequoia (version 15.5).
Additional Description: This PR significantly enhances the existing dev container documentation by adding a comprehensive setup guide that walks through the entire process from repository cloning to successful debugging. The original documentation was brief and referenced external guides, but this enhancement provides a complete, self-contained walkthrough with troubleshooting solutions for common issues encountered during setup.
The guide is particularly valuable for developers who are not C++ experts and may be unfamiliar with Bazel build systems. It includes visual documentation with 16 screenshot images showing key steps and verification points.
Risk Level: Low
Testing:
Docs Changes: Enhanced .devcontainer/README.md with comprehensive setup guide including:
Release Notes: N/A
Platform Specific Features: N/A - Documentation changes only, though the guide specifically addresses macOS compatibility issues with debugger configuration.