Skip to content

Add integration documentation template #1575

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

Merged
merged 3 commits into from
Jul 8, 2025

Conversation

Calm-Rock
Copy link
Member

@Calm-Rock Calm-Rock commented Jun 19, 2025

Fixes #1507

ECS docs PR - #1652

Copy link

vercel bot commented Jun 19, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
signoz-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 8, 2025 0:16am

- Streamlined template to match ECS integration structure
- Combined title and overview sections
- Added "What You'll Monitor & Data Collected" section
- Included collapsible dropdowns for logs and metrics
- Added dashboard sections with placeholder images
- Removed complex setup, prerequisites, and troubleshooting sections
- Added dummy integrations link at the end
- Template now follows simplified one-click integration approach
@Calm-Rock
Copy link
Member Author

Template Updated to Match ECS Integration Format 🚀

I've updated the integration template to match the streamlined format used in the ECS integration (PR #1652). The template now follows the simplified one-click integration approach.

Key Changes:

  • Streamlined structure: Removed complex setup/troubleshooting sections
  • ECS format alignment: Combined title/overview, data collection with dropdowns
  • Dashboard sections: Overview and enhanced feature dashboards
  • Template variables: Easy to customize for any AWS service
  • One-click focus: Emphasizes the seamless integration experience

Template Usage:

Replace placeholder variables like [Service Name] and [service-name] with actual service details, fill in metrics/logs from the service's integration.json, and add real dashboard screenshots.

The template is now ready for consistent AWS integration documentation! 📝

Copy link
Contributor

@piyushsingariya piyushsingariya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Calm-Rock Calm-Rock merged commit 1ef17b0 into main Jul 8, 2025
2 checks passed
@Calm-Rock Calm-Rock deleted the create-integration-docs-template branch July 8, 2025 13:44
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] Create a template for the integrations docs
2 participants