Skip to content

docs: Add 6 new integration pages and register existing docs in navig…#2769

Merged
Devesh36 merged 7 commits into
Tracer-Cloud:mainfrom
bhavESH-CHAWLA:docs/add-missing-integrations
Jun 13, 2026
Merged

docs: Add 6 new integration pages and register existing docs in navig…#2769
Devesh36 merged 7 commits into
Tracer-Cloud:mainfrom
bhavESH-CHAWLA:docs/add-missing-integrations

Conversation

@bhavESH-CHAWLA

@bhavESH-CHAWLA bhavESH-CHAWLA commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Fixes #2767

Describe the changes you have made in this PR -

  • Added documentation pages for Azure SQL, MongoDB Atlas, OpenObserve, Snowflake, Supabase, and Trello integrations.
  • Updated documentation navigation to include all newly added integration guides.
  • Added setup instructions, environment variable configuration, persistent store examples, and verification steps for each integration.
  • Reviewed and aligned documentation examples with the current implementation and supported environment variables.
  • Improved Snowflake account identifier guidance for different account formats and regions.
  • Updated OpenObserve, Supabase, and MongoDB Atlas configuration examples to match supported authentication methods.
  • Corrected Trello token guidance and updated verification command examples.

Demo/Screenshot for feature changes and bug fixes -

Documentation-only changes.

Attached screenshots demonstrate:

  • Newly added integration documentation pages
  • Updated documentation navigation entries
  • Rendered documentation pages for the supported integrations

Code Understanding and AI Usage

Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?

  • No, I wrote all the code myself
  • Yes, I used AI assistance (continue below)

If you used AI assistance:

  • I have reviewed every single line of the AI-generated code
  • I can explain the purpose and logic of each function/component I added
  • I have tested edge cases and understand how the code handles them
  • I have modified the AI output to follow this project's coding standards and conventions

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

  • I have added proper PR title and linked to the issue
  • I have performed a self-review of my code
  • I can explain the purpose of every function, class, and logic block I added
  • I understand why my changes work and have tested them thoroughly
  • I have considered potential edge cases and how my code handles them
  • If it is a core feature, I have added thorough tests
  • My code follows the project's style guidelines and conventions

Note: Please check Allow edits from maintainers if you would like us to assist in the PR.

…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
@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Greptile code review

This 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:

@greptile review

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-apps

greptile-apps Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This 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 (argocd, airflow, victoria_logs) in the navigation. Issues flagged in the prior review rounds — the Snowflake SQL syntax error and account-identifier guidance — have been addressed in this version.

  • New docs (5 pages + 1 rewrite): Each page follows the established pattern of guided setup, env var table, persistent-store JSON example, and a verify/troubleshoot section; all referenced pages exist in the repo.
  • docs.json navigation: Adds nine page references across the Observability, Cloud/Collaboration, and Data/Workflow groups; all target files are present on disk.
  • Minor inconsistencies: The Supabase env var table is missing the Default column and Required markers used by every other new page, and the OpenObserve table omits the alternative OPENOBSERVE_USERNAME/OPENOBSERVE_PASSWORD variables that are described in the text below it.

Confidence Score: 5/5

Documentation-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

Filename Overview
docs/azure-sql.mdx New Azure SQL integration doc — well-structured with setup, firewall, and troubleshooting sections; one slightly misleading instruction in the "finding your connection details" steps.
docs/docs.json Navigation additions for openobserve, victoria_logs, argocd, trello, airflow, azure-sql, mongodb-atlas, snowflake, and supabase; all referenced mdx files exist on disk.
docs/integrations/trello.mdx Substantially rewritten — adds env var table, persistent store example, board/list ID discovery, and token guidance; previous inline literal newline issue appears resolved.
docs/mongodb-atlas.mdx New MongoDB Atlas integration doc using the Admin API with public/private key auth — accurate, complete env var table, and correct verify command.
docs/openobserve.mdx New OpenObserve doc covering token and username/password auth; the username/password env vars are described in a separate section but omitted from the reference table.
docs/snowflake.mdx New Snowflake doc; previously flagged issues (SQL syntax and account identifier guidance) are now corrected — uses proper Snowflake DDL and advises using the full identifier.
docs/supabase.mdx New Supabase doc — clear and accurate, but the env var table is missing the Default column and Required markers present in every other integration page added in this PR.

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]
Loading

Reviews (5): Last reviewed commit: "docs(mongodb-atlas): update environment ..." | Re-trigger Greptile

Comment thread docs/trello.mdx Outdated
Comment thread docs/snowflake.mdx Outdated
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@Davidson3556

Copy link
Copy Markdown
Contributor

@greptile review

@Devesh36

Devesh36 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Could u just link the issue which u are solving also aim for 5/5 greptile score

@Devesh36

Devesh36 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

also put the screenshot for demo

@bhavESH-CHAWLA

Copy link
Copy Markdown
Contributor Author

@Devesh36 is current pr on the issue is not good or anything

@bhavESH-CHAWLA

Copy link
Copy Markdown
Contributor Author

@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

@cerencamkiran

Copy link
Copy Markdown
Collaborator

We already have a Trello doc under docs/integrations/trello.mdx.

@Devesh36

Devesh36 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

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

@Devesh36

Devesh36 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

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

@Devesh36

Devesh36 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

We already have a Trello doc under docs/integrations/trello.mdx.

yeah we need it in nav

@bhavESH-CHAWLA

Copy link
Copy Markdown
Contributor Author

@Devesh36 acknowledged

@Devesh36

Copy link
Copy Markdown
Collaborator

@Devesh36 acknowledged

Hey i don't see any new commits regarding the changes ? are you working on them ?

@bhavESH-CHAWLA

Copy link
Copy Markdown
Contributor Author

@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.

@bhavESH-CHAWLA

Copy link
Copy Markdown
Contributor Author

@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.

Comment thread supabase.py Fixed
@bhavESH-CHAWLA

Copy link
Copy Markdown
Contributor Author

@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>
@Devesh36

Copy link
Copy Markdown
Collaborator

@greptile-apps review again

Comment thread docs/snowflake.mdx Outdated
… 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.
@Devesh36

Copy link
Copy Markdown
Collaborator

@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.
@Devesh36

Copy link
Copy Markdown
Collaborator

@greptile-apps review again

@Devesh36 Devesh36 merged commit 83d5a1f into Tracer-Cloud:main Jun 13, 2026
4 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🌊 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.

@bhavESH-CHAWLA bhavESH-CHAWLA deleted the docs/add-missing-integrations branch June 13, 2026 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs:Add missing integration docs

5 participants