Add non client libraries section#187
Conversation
Adds a new section to the connectors overview to document libraries that do not provide client connectors, improving discoverability and clarity for users. Closes wso2#174
Eranga035225
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
|
|
📝 WalkthroughOverviewAdds a new documentation section to the connectors overview describing libraries that do not provide dedicated client connectors in WSO2 Integrator. Changes
ImpactAddresses documentation gap for non-client libraries, improving discoverability and providing clear guidance for users on the full range of available libraries in WSO2 Integrator. WalkthroughThe pull request adds a new documentation section to the connector overview titled "Libraries without client connectors." The section describes non-connector libraries shipped with WSO2 Integrator, including examples such as PDF operations, string manipulation, I/O operations, AWS Lambda, and Azure Functions. It documents their typical usage patterns within integration flows for internal processing, data transformation, and invoking external services without dedicated client connectors, and notes potential considerations regarding environment-specific configuration requirements. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
en/docs/connectors/overview.md (2)
82-90: Add direct links for each example category to improve discoverability.The examples are useful, but users still need to search manually. Linking each bullet (PDF, String, I/O, AWS Lambda, Azure Functions) to its relevant documentation page would better satisfy the discoverability goal.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/connectors/overview.md` around lines 82 - 90, Convert the five plaintext bullets into markdown links so each example category is directly clickable: replace "PDF operations", "String manipulation", "I/O operations", "AWS Lambda integration", and "Azure Functions" with markdown link text that points to their respective example docs (the PDF example page, the String manipulation example page, the I/O operations example page, the AWS Lambda integration example page, and the Azure Functions example page), ensuring link labels exactly match the existing bullet text for discoverability and leaving the "Usage" paragraph unchanged.
94-95: Make “Considerations” more actionable with one concrete reference.The guidance is valid but generic. Add at least one explicit pointer (for example, a deployment/configuration doc link) so users can act immediately.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/connectors/overview.md` around lines 94 - 95, Update the "Considerations" bullets (the two lines starting "These libraries may require additional configuration..." and "They are often used alongside connectors...") to include at least one concrete, actionable pointer: add a direct link and short callout to the relevant deployment/configuration guide (for example, "See the Deployment & Configuration guide for environment-specific settings" or a specific section like "Kubernetes deployment" or "Cloud provider integration") so readers can immediately follow to detailed setup steps; keep the original notes but append the explicit reference and a one-line example of where to look.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@en/docs/connectors/overview.md`:
- Around line 82-90: Convert the five plaintext bullets into markdown links so
each example category is directly clickable: replace "PDF operations", "String
manipulation", "I/O operations", "AWS Lambda integration", and "Azure Functions"
with markdown link text that points to their respective example docs (the PDF
example page, the String manipulation example page, the I/O operations example
page, the AWS Lambda integration example page, and the Azure Functions example
page), ensuring link labels exactly match the existing bullet text for
discoverability and leaving the "Usage" paragraph unchanged.
- Around line 94-95: Update the "Considerations" bullets (the two lines starting
"These libraries may require additional configuration..." and "They are often
used alongside connectors...") to include at least one concrete, actionable
pointer: add a direct link and short callout to the relevant
deployment/configuration guide (for example, "See the Deployment & Configuration
guide for environment-specific settings" or a specific section like "Kubernetes
deployment" or "Cloud provider integration") so readers can immediately follow
to detailed setup steps; keep the original notes but append the explicit
reference and a one-line example of where to look.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 39f9f677-574e-46f0-a8fd-cc64ec9c980b
📒 Files selected for processing (1)
en/docs/connectors/overview.md
2 participants
Closes #174
This PR adds a new section to the connectors overview to document libraries that do not provide client connectors, improving discoverability and clarity for users.
AI-assisted: Yes (content drafted with assistance and reviewed manually)