docs: Add 6 new integration pages and register existing docs in navig…#2769
Conversation
…ation New integration documentation pages created: - Azure SQL (azure-sql.mdx) — diagnose database issues and query performance - MongoDB Atlas (mongodb-atlas.mdx) — cloud-hosted MongoDB cluster health and analytics - OpenObserve (openobserve.mdx) — structured logs and traces for incident correlation - Snowflake (snowflake.mdx) — data warehouse querying and analytics pipeline debugging - Supabase (supabase.mdx) — PostgreSQL database and authentication troubleshooting - Trello (trello.mdx) — incident card management and follow-up tracking Updated navigation in docs.json to include: - Existing docs now linked: Airflow, Argo CD, VictoriaLogs - New docs: All 6 above All pages follow OpenSRE docs style and include: - Friendly, conversational setup instructions - Environment variables configuration - Persistent store JSON examples - Security best practices (read-only roles, key pair auth, IP allowlisting) - Verification commands for testing connections
Greptile code reviewThis repo uses Greptile for automated review. Before merge, aim for Confidence Score: 5/5 with zero unresolved review threads — see CONTRIBUTING.md. Run a review — add a PR comment with: Give it ~5-10 minutes (sometimes longer) for results, then fix feedback and re-trigger until you reach Confidence Score: 5/5. Optional: automate with the greploop skill. |
Greptile SummaryThis PR adds six new integration documentation pages (Azure SQL, MongoDB Atlas, OpenObserve, Snowflake, Supabase, and an updated Trello page) and registers those plus several pre-existing docs (
Confidence Score: 5/5Documentation-only change; all referenced pages exist, navigation entries are valid, and no integration logic is modified. All six new/updated pages follow the established structure, previously flagged Snowflake SQL and account-identifier errors are corrected, and every docs.json page reference resolves to an existing file. The remaining comments are wording inconsistencies with no runtime impact. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User sets up OpenSRE integration] --> B{Auth method}
B --> C[Interactive: opensre integrations setup]
B --> D[Environment variables in .env]
B --> E[Persistent store: ~/.opensre/integrations.json]
C --> F[Integration activated]
D --> F
E --> F
F --> G{Integration type}
G --> H[Azure SQL ODBC / SQL auth]
G --> I[MongoDB Atlas Admin API public+private key]
G --> J[OpenObserve Token or username/password]
G --> K[Snowflake Account identifier + token]
G --> L[Supabase Service role key]
G --> M[Trello API key + token]
H & I & J & K & L & M --> N[opensre integrations verify service]
N --> O[Investigation tools available in OpenSRE]
Reviews (5): Last reviewed commit: "docs(mongodb-atlas): update environment ..." | Re-trigger Greptile |
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
|
@greptile review |
|
Could u just link the issue which u are solving also aim for 5/5 greptile score |
|
also put the screenshot for demo |
|
@Devesh36 is current pr on the issue is not good or anything |
|
@Devesh36 since the issue was simple i dont get the screenshot and deleted local repo from my system thus it will be impossible for me to repeat thing one again |
|
We already have a Trello doc under docs/integrations/trello.mdx. |
|
Add Fixes #2767 to the PR body Verify commands: docs use opensre integrations verify --id … but the CLI has no --id flag; use opensre integrations verify (and check whether Trello even supports verify) MongoDB Atlas: doc uses connection-string vars; code expects Atlas API keys (MONGODB_ATLAS_PUBLIC_KEY, MONGODB_ATLAS_PRIVATE_KEY, MONGODB_ATLAS_PROJECT_ID) OpenObserve: wrong env vars — should be OPENOBSERVE_URL, OPENOBSERVE_TOKEN/USERNAME+PASSWORD, OPENOBSERVE_ORG Supabase: doc describes direct Postgres; code uses SUPABASE_URL + SUPABASE_SERVICE_KEY Snowflake: account ID guidance may break non-US regions Trello: fix token expiry text + markdown fence issue Please align env vars/credentials/verify with the actual integrations before next commit |
address this issue @bhavESH-CHAWLA |
yeah we need it in nav |
|
@Devesh36 acknowledged |
Hey i don't see any new commits regarding the changes ? are you working on them ? |
|
@Devesh36 thankyou for your concern I have been working on this I will submit the pr by today or latest by tomorrow as I was busy working on some other issue and my project. |
|
@Devesh36 Thanks for the feedback. I've gone through the review comments and updated the affected integration docs (MongoDB Atlas, Supabase, OpenObserve, Snowflake, and Trello) to match the current implementation. I've also updated the configuration examples and verification steps where needed. Please let me know if you notice anything else that should be improved. |
|
@Devesh36 please reveiw |
Align verify commands and env vars with the implementation, consolidate Trello into docs/integrations/trello.mdx, and fix broken MDX frontmatter. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@greptile-apps review again |
… OpenObserve, Snowflake, Supabase, and Trello - Added new environment variables and investigation tools sections for Azure SQL and MongoDB Atlas. - Expanded troubleshooting and security best practices for Snowflake and Supabase. - Updated Trello documentation to include usage instructions for creating cards from investigations. - Improved overall clarity and completeness of integration guides.
|
@greptile-apps review again |
…rity - Changed the environment variable table to include a 'Default' column. - Enhanced descriptions to emphasize the requirement status of each variable.
|
@greptile-apps review again |
|
🌊 Merged. @bhavESH-CHAWLA is now permanently woven into git history. No take-backs. 😄 👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome. |

Fixes #2767
Describe the changes you have made in this PR -
Demo/Screenshot for feature changes and bug fixes -
Documentation-only changes.
Attached screenshots demonstrate:
Code Understanding and AI Usage
Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?
If you used AI assistance:
Explain your implementation approach:
This PR focuses on expanding and improving integration documentation for OpenSRE.
The implementation involved creating documentation pages for multiple integrations and ensuring that setup instructions, environment variables, authentication methods, persistent store examples, and verification steps accurately reflect the current implementation.
Documentation examples were validated against the integration configuration and supported environment variables to ensure consistency and reduce setup issues for users. The goal was to provide clear onboarding instructions while keeping the documentation aligned with actual integration behavior.
Checklist before requesting a review
Note: Please check Allow edits from maintainers if you would like us to assist in the PR.