ballerina-platform/ballerina-central

Ballerina Central Website

ballerina-central's Issues

[API Docs] Improve heading styles for Parameters and Return types

Description:
$subject

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Unable to create my first organisation when I signup

Description:
$Subject

Error message

authentication failure: client certificate validation failed

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:
Sign-up with Gmail
create an organisation
failure!
Sign-up with Github
create an organisation
failure!

Related Issues:

Update the search text in API Docs

Description

Need to update the search text (i.e., Search in distribution) in [lib.ballerina.io](https://lib.ballerina.io/). Saying distribution might not be meaningful here.

Related website/documentation area

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

Describe your task(s)

A detailed description of the task.

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.

API Documentation link broken on several connectors

Description:
API Documentation link is broken and gives 404 on many connectors in central.ballerina.io

Notice in at least on these (in addition to MySQL and PostgreSQL),

• https://central.ballerina.io/ballerinax/jaeger
• https://central.ballerina.io/ballerinax/choreo

`latest` URL of the packages give 500 error

Description:

$subject for packages.

e.g. https://lib.ballerina.io/ballerina/http/latest is giving 500 error.
But the latest version with the number is working : https://lib.ballerina.io/ballerina/http/2.6.0

[API Docs] Show resource methods

Description:
$subject

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Lang libs not loading on API Docs landing page

Description:
The language libraries section is not loading on the API Docs landing page as shown below.

Image

Screen recording

Screen.Recording.2023-02-28.at.08.34.23.mov

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Revamp the API Docs

Description

Need to do a full revamp of the API Docs in [lib.ballerina.io](https://lib.ballerina.io/). Basically, this should be focussed on improving the user experience and the look and feel of it.

Related website/documentation area

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

Describe your task(s)

A detailed description of the task.

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.

Bug: Package.md not rendered correctly

Description:
When Package.md contains only a <p> string (i.e. no #-type markdown header), the package site on central - very curiously - only renders the last character of the sentence.

My Package.md (modified to reproduce the issue):

Ballerina central package page:

Suggested Labels:
Bug

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Provide details about missing packages when pulling from Central

If dependencies are missing in Central when pushing a package, it gives an error saying the package could not be pushed because dependencies were missing. Will it be possible to improve this error message to include which packages are missing as well? Then it'll be easy to identify the missing packages.

ballerina: unable to push package as there are dependencies of the package missing in the registry

Rabbitmq is not shown in the home page

Description:
$subject

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Add a deprecation notice to STAN

Description

We need to add a deprecation notice to Ballerinax STAN module, since the underlying NATS streaming server is now deprecated by NATS.

Suggested assignee(s) (optional)

@praneesha

[API Docs] Extended libraries are not appearing in search results of home page serach.

Description:

$subect in the lib.ballerina.io landing page.

Try search mysql in landing page search bar.

it gives empty results as follows and this is not acceptable.

Check broken links of `lib.ballerina.io`

Description:
Need to run a link checker and fix the broken links in lib.ballerina.io.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Azure Functions and AWS Lambda are missing in `lib.ballerina.io`

Description:
Azure Functions and AWS Lambda packages are missing in the lib.ballerina.io landing page.

Need to check and add them.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Remove the sign in/up option in `lib.ballerina.io`

Description

Remove the sign in/up option in lib.ballerina.io as this is relevant only for Ballerina Central.

Related website/documentation area

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

Describe your task(s)

A detailed description of the task.

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.

Documentation for the latest version of http gives a 404

Description:
Documentation for latest version of http gives a 404 in API Docs. The issue can be reproduced with both [1] & [2].

[1] https://lib.ballerina.io/ballerina/http/2.4.0
[2] https://lib.ballerina.io/ballerina/http/latest

Suggested Labels:

Suggested Assignees:

Affected Product Version:
Production

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

[API Docs] Show Service types

Description:
$subject

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Update the API Docs logo

Description

Need to update the text of the logo below in [lib.ballerina.io](https://lib.ballerina.io/) from Ballerina Docs to Ballerina API Docs.

Steps to reproduce

The steps to be followed to reproduce the issue.

Affected version(s)

The versions that are affected by the issue.

Related website/documentation area

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

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.

[API Docs] - Can we have the same order in the source file for the constants

Description:

$subject. Otherwise the constants which are having some practical order appear in an inappropriate way.

https://lib.ballerina.io/ballerina/time/2.1.0#Constants

Source file has the order or Sunday , Monday , Tuesday etc. But the page displays it in complete random order it seems.

Redesign the API Docs landing page

Description

$subject

• [ ]#5616
• [ ]#5602
• [ ]#5600

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.

[API Docs] SFDC package thumbnail image is not loading in api docs landing page.

Description:

$subject as follows. But it is available in central.

Switch module detail page to server side rendering

Description:
$subject

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Update the copyright statement of `lib.ballerina.io`

Description:
Need to update the copyright statement below of lib.ballerina.io.

Should be updated as shown below.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

[API Docs] Open records are displayed incorrectly

Description:
We need to have a better way to display open records. Currently, it seems field descriptions etc are empty.

E.g. : https://lib.ballerina.io/ballerina/time/2.1.0#Date

[API Docs] The `*` seems not necessary when describing type inclusion

Description:

$subject. Since we say Type included from in words, having another * in between is not necessary.

For example see : https://lib.ballerina.io/ballerinax/mssql/1.7.0#CurvePolygonValue

Add `search by tag` support for central packages

Description:

$subject.

Need the ability to search by tag in central.
Also, licking on the tag is directed to the package itself now. Instead, it should list all the packages with the same tag.

`observe` standard library tooltip not displayed correctly in API Docs

Description

A brief description of the bug.

$title in https://lib.ballerina.io/

Steps to reproduce

The steps to be followed to reproduce the issue.

Affected version(s)

The versions that are affected by the issue.

Related website/documentation area

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

Area/UIUX

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.

The API docs website search bar text is not visible

Description:

The text entered inside the Jump to... search bar of the API docs website is not visible.

Steps to reproduce:

Screen.Recording.2023-03-03.at.15.15.13.mov

Cannot access API docs for jballerina.java

Description:
cannot access the API docs for jballerina.java as it gives a 404 error. https://lib.ballerina.io/ballerina/jballerina.java/0.0.0

A newly added function and a type in the `lang.runtime` are not shown in API Docs

Description:

With 2201.2.0 release type StopHandler and function onGracefulStop(StopHandler) should be added to the Ballerina API docs in https://lib.ballerina.io/ballerina/lang.runtime/0.0.0. But they are not there.

Also found out there is a missing backtick in the runtime.bal file. See ballerina-platform/ballerina-spec#1180. If that is the reason, I think it is better to add a way to find out such errors which leads to API Doc generation failures.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Add resource methods to method signature

Description:
$subject

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

API Docs Page is Reloading Frequently with Session Expired Notice

Description:

The Ballerina API docs pages frequently (about every 1 minute) show a Session Expired notice and reload the page. This is bad UX.

OS, DB, other environment details and versions:
Browser: Safari: Version 16.0 (17614.1.25.9.10, 17614)

[API Docs] The arrow in breadcrumb is misaligned

Description:

$subject in module pages.

Heading `fields` is appearing when there are no fields

Description:
$subject - https://lib.ballerina.io/ballerina/graphql/1.6.0#Interceptor

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Builds and Test runs are taking a long time or running indefinitely

Description:
I am executing some ballerina code in a docker container ballerina/ballerina:2201.2.3 and it seems to be random that some builds/tests runs will be very slow or never finish. I left one to run and stopped it after 4000 seconds. The code is the hello-world sample

Accessor and resource path are not shown in the function in API docs

Description:
Accessor and resource path should be shown in the resource function as it shows the function name for other functions.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

API Docs - Redesigned the detailed module pages

Description

$subject

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 new feature.

Describe your solution(s)

A detailed description of how this new feature 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.

Error when loading API docs for a central package when API docs are not available

Description:
Error when loading API docs for a central package when API docs are not available.

ballerinax/mysql.driver/1.3.0 does not have API docs. But, the API docs link for that package is visible and when accessed, fails to load the docs and results in a gateway timeout.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

API Documentation for postgresql.driver gives 404

Description:
API Documentation for PostgreSQL driver gives 404

API Docs search gives invalid resutls

Description:
For example search for the word execute

None of the results seems to be related to the word execute

Introduce a package deletion policy for public packages

Description:
$subject

API Documentation link in mysql.driver page gives 404

Description:
API Documentation link in mysql.driver page gives 404

[API Docs] API docs has very high loading time

Description:
$subject as it takes a considerable amount of time to load the page which is not acceptable.

Try the URL lib.ballerina.io in a new tab.

Typo in GraphQL API Docs

Description:
GraphQL/1.5.0/Overview/Service/Mutation Type code sample has a typo, as seen below.

[updateCity remote function returns]

Docs URL: https://lib.ballerina.io/ballerina/graphql/1.5.0

Pull Count Only Calculated for the Latest Version

Description:

When searching for a package in the Ballerina central, the default sorting method is to sort by pull count.

This helps to find the most used packages for a certain search query. But there is a small issue. The pull count is calculated only for the latest version of a package. IMO, the pull count should show the entire package to get the maximum advantage of sorting by pull count. Otherwise, a newly released version of a well-used package might end up at the end of the search results while other (sometimes obsolete) packages are shown at the top.

Check the following screenshot:

Here, the most used package related to the query graphql is (by-far) the ballerina/graphql package. But the latest release of the ballerina/graphql package has 0 pull counts, it is placed at the bottom of the search results.

Add the missing `test` module in API Docs

Description:
Need to add the missing test module[1] in API Docs.

It shows up when searched but the page is not available. Also,the following error is appearing intermittently when clicking on packages:

[1] https://lib.ballerina.io/ballerina/test/latest

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Show Openai modules in home page

Description:
$subject

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Give the option to select the Ballerina version in API docs

Description

Currently the API docs site doesn't have any option for the user to select the Ballerina version for which they're looking up the docs. It would make it better if the user had the option to select the Ballerina version in the docs as well.

http is not shown under Standard library

Description:
http is not shown under Standard library in https://lib.ballerina.io/

Suggested Labels:

Suggested Assignees:

Affected Product Version:
Production

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues: