Skip to content
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

Fix connector examples links in central to point to the correct branch in source repo #9381

Open
NipunaRanasinghe opened this issue Sep 10, 2024 · 0 comments
Assignees
Labels
Kind/Connectors Type/Improvement Improvements required on the website.

Comments

@NipunaRanasinghe
Copy link
Contributor

NipunaRanasinghe commented Sep 10, 2024

Description

Currently all the connector examples listed under the connector API docs (in the central) are pointed to the master/main branch of the source repository (e.g. https://central.ballerina.io/ballerinax/salesforce/8.1.0#examples)

This approach could lead to issues when breaking changes are introduced in the master branch that are not yet reflected in the stable release. Users might follow outdated or incompatible examples, resulting in confusion or errors when trying to run the examples.

To address this, it would be more effective to link the examples to a specific release tag or version in the source repository.

Related website/documentation area

Add/Uncomment the relevant area label out of the following.

Describe the problem(s)

A detailed description of the purpose of this improvement.

Describe your solution(s)

A detailed description of how this improvement will solve the problem described above.

Related issue(s) (optional)

Any related issues such as sub tasks and issues reported in other repositories (e.g., component repositories), similar problems, etc.

Suggested label(s) (optional)

Optional comma-separated list of suggested labels. Non committers can’t assign labels to issues, and thereby, this will help issue creators who are not a committer to suggest possible labels.

Suggested assignee(s) (optional)

Optional comma-separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, and thereby, this will help issue creators who are not a committer to suggest possible assignees.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Kind/Connectors Type/Improvement Improvements required on the website.
Projects
Status: Backlog
Development

No branches or pull requests

3 participants