-
Notifications
You must be signed in to change notification settings - Fork 1.4k
misc: revamped gateway docs #4520
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
Conversation
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Summary
This PR comprehensively revamps the Infisical Gateway documentation to improve usability and clarity. The changes restructure the existing documentation from a single overwhelming guide into a well-organized, multi-page structure that follows a logical user journey.
Key improvements include:
Restructured Navigation: The documentation is now organized into distinct sections - overview, deployment, networking requirements, and security - allowing users to find relevant information more easily. The docs.json
file reflects this improved organization with a more logical page ordering.
Enhanced Overview: The overview.mdx
file has been transformed from a dense all-in-one guide into a focused introduction that clearly explains the concepts of Gateways and Relay servers, their differences, and use cases before directing users to specialized implementation guides.
New Comprehensive Deployment Guide: A new deployment.mdx
file provides detailed step-by-step instructions for various deployment methods including Linux systemd services, Kubernetes Helm charts, and development environments. It includes proper warnings about Gateway v2 migration requirements and authentication configurations.
Expanded Networking Documentation: The networking.mdx
file now includes detailed relay server requirements, cloud provider-specific firewall configuration examples (AWS, GCP, Azure), performance considerations, and enhanced FAQ sections.
Improved Security Documentation: The security.mdx
file has been restructured with corrected technical diagrams, comprehensive security best practices, compliance considerations, and troubleshooting guidance.
Enhanced CLI Documentation: The relay.mdx
CLI documentation adds comprehensive coverage of the new infisical relay systemd
command for managing relay services as systemd services.
These changes reflect a documentation maturation effort, moving from basic instructions to comprehensive enterprise-ready guidance that addresses common deployment scenarios and reduces support burden.
PR Description Notes:
- The PR description checkboxes are not filled out (Type and acknowledgment sections remain unchecked)
- The Tests section contains only placeholder content
Confidence score: 5/5
- This PR is extremely safe to merge with virtually no risk of production issues
- Score reflects that this is purely documentation improvement with no functional code changes or breaking modifications
- No files require special attention as all changes enhance user experience without affecting system functionality
Context used:
Context - When naming sections in documentation, use clear and descriptive titles that reflect the functionality to avoid confusion among users. (link)
Context - Use 'email auth' instead of 'direct credential login' in documentation to provide clearer terminology for users. (link)
6 files reviewed, no comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since we won't mention instance type deployment, we'll need to write how to deploy a gateway for org scoped. i have left that black since you are working on the feature as we speak
Description 📣
This PR improves gateway docs to be easier to follow. The PR also adds CLI docs for relay systemd install and uninstall
Type ✨
Tests 🛠️
# Here's some code block to paste some code snippets