Skip to content

Update docs for Prometheus client API upgrade#2095

Merged
ravindu25 merged 1 commit intowso2:4.2.0from
ravindu25:4.2.0
Mar 19, 2026
Merged

Update docs for Prometheus client API upgrade#2095
ravindu25 merged 1 commit intowso2:4.2.0from
ravindu25:4.2.0

Conversation

@ravindu25
Copy link
Contributor

@ravindu25 ravindu25 commented Mar 19, 2026

Update 4.2.0 documentation for: wso2/product-micro-integrator#4479

Summary by CodeRabbit

  • New Features

    • Added comprehensive documentation for API-led integration patterns
    • Introduced Micro Integrator for VS Code extension guides and quick-start tutorials
    • Added custom analytics event publishing capabilities
    • Integrated Datadog-based analytics solution documentation
  • Documentation

    • Expanded configuration reference guides and examples
    • Updated and reorganized mediation sequences documentation
    • Enhanced connector documentation with new parameters and use cases
    • Improved navigation and cross-references across documentation
  • Bug Fixes

    • Corrected documentation links and references
    • Fixed configuration examples and outdated paths

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 2026

Caution

Review failed

Failed to post review comments

Walkthrough

Large-scale documentation update for WSO2 Micro Integrator including new guides for VS Code extension, API-led integration, custom analytics, and connector references. Updates include credential placeholder replacements, link migration from deprecated sequence-properties to mediation-sequences, UI/theme improvements with versioning dropdown, and configuration catalog expansions.

Changes

Cohort / File(s) Summary
VS Code Extension Documentation
en/docs/develop/mi-for-vscode/*
New pages introducing Micro Integrator for VS Code extension including installation instructions, overview, and quick-start guide for building integration solutions with AI-assisted artifact generation.
API-Led Integration & Analytics
en/docs/develop/api-led-integration.md, en/docs/mi-analytics/*
New documentation on API-led integration workflows and three analytics solutions (Datadog, ELK, custom events data publishing) with detailed setup and configuration guidance.
Documentation Link Migration (sequence-properties → mediation-sequences)
en/docs/develop/creating-artifacts/*, en/docs/reference/mediators/*, en/docs/reference/synapse-properties/*
Updated 25+ files to replace deprecated sequence-properties references with new mediation-sequences documentation page and anchors across integration artifacts, mediators, and proxy/REST API configurations.
Connector Documentation & Credentials
en/docs/reference/connectors/amazon*/..., en/docs/reference/connectors/*-connector*
Replaced hardcoded AWS/cloud credentials with placeholder comments across Amazon (DynamoDB, Lambda, S3, SQS), SMPP, Kafka, Salesforce, and other connectors; updated configuration references and added version-specific setup guidance.
Connector Configuration & Reference
en/docs/reference/connectors/csv-module/..., en/docs/reference/connectors/file-connector/..., en/docs/reference/connectors/kafka-connector/..., en/docs/reference/connectors/redis-connector/...
Added/expanded connector references including CSV module transformation documentation, file-connector SMB2 support and operation parameters, Kafka versioned setup (3.2.0+), and comprehensive Redis command reference.
Mediator & Sequence Documentation
en/docs/reference/mediation-sequences.md, en/docs/reference/mediators/call-mediator.md, en/docs/reference/mediators/class-mediator.md
New mediation-sequences page explaining IN/OUT/fault/named/dynamic sequences; updated mediator documentation with typo fixes, new attributes (Clone sequential/iterations), and dynamic property access guidance.
Configuration Catalog Updates
en/docs/reference/config-catalog-mi.md, en/docs/reference/config-catalog-mi-dashboard.md
Expanded configuration references including OpenTelemetry observability settings, REST API CORS configuration, keystore type restrictions, RabbitMQ parameter changes, and new SSO cookie parameter.
Setup & Installation Documentation
en/docs/install-and-setup/install/*, en/docs/install-and-setup/setup/*
Updated installation prerequisites (centralized/decentralized deployment sizing), Helm deployment versions (4.2.0.1), WebLogic 14.1.1 integration, database connection handling, and broker/transport configurations.
Performance, Monitoring & Security
en/docs/install-and-setup/setup/deployment-best-practices/*, en/docs/observe-and-manage/*
Added TCP transport performance test documentation, Script Mediator security guidelines, OpenTelemetry tracing configuration updates, Prometheus v1 API support, and Fluent Bit/Loki setup revisions.
Styling & Theme Updates
en/docs/assets/css/blue-palette-alt1.css, en/docs/assets/css/mitheme.css, en/docs/assets/js/mitheme.js
Updated banner image to WebP format, added responsive banner styling, implemented custom dropdown styles for version/distribution selectors, and added JavaScript for version dropdown population and dynamic documentation linking.
HTML Templates & Analytics Integration
en/theme/material/base.html, en/theme/material/main.html, en/theme/material/partials/*
Added CookiePro consent notice integration, Google Tag Manager bootstrap and noscript tags, new header partial with version dropdown scaffold and conditional rendering for navigation elements.
Documentation Structure & Configuration
en/mkdocs.yml, en/docs/index.md, en/docs/googlefc84cfcfd6dd83b6.html
Updated navigation hierarchy for new VS Code/analytics sections, added connector documentation paths, configured redirect mappings for deprecated sequence-properties, updated homepage hero text and Enterprise Integration Patterns link targets, removed Google site verification file.
Miscellaneous Documentation Updates
en/docs/get-started/*, en/docs/learn/*, en/docs/reference/troubleshooting/*
Formatting fixes, capitalization corrections, updated database/file handling examples, clarified error code consolidation, and removed outdated tips/warnings across tutorials and reference guides.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 Hops of joy through docs so vast,
Links redirected, credentials masked!
New VS Code paths shine so bright,
Version dropdowns, analytics in sight!
Templates dance with Jinja's grace,
WSO2 Integrator's better place!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

@ravindu25 ravindu25 merged commit 5de2dbd into wso2:4.2.0 Mar 19, 2026
2 checks passed
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.

2 participants