ballerina-platform / ballerina-dev-website Goto Github PK

Description:
In how to deploy and run ballerina programs documentation page [1], please include the usage of
--b7a.config.secret=path/to/secret/file flag.
[1] https://ballerina.io/learn/how-to-deploy-and-run-ballerina-programs/
Version 1.0

Steps to reproduce:
N/A

Affected Versions:
V1.0 documentation

OS, DB, other environment details and versions:
N/A

Related Issues (optional):
N/A

Suggested Labels (optional):
Documentation
How to deploy and run ballerina programs

Suggested Assignees (optional):
Pubudu Fernando (pubudu91)

The heading is worded as "Getting set up to dance". IMO, this is just taking the whole Ballerina narrative too far. Kind of similar to the issue we had with the following line in the bad-sad error: We thank you for helping make us better dancers

Description:
When I search ballerina lang on google, wrong description is shown for ballerina.
(I'm talking about the description under the link, not the right side pane extracted from wikipedia in other 2 screenshots)

Reference.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
Refer ballerina-platform/ballerina-lang#8324 for details

Description:
Four of the BBEs on the website link to the wrong Github URLs through the Github icon:

• AWS Lambda: Icon should link to https://github.com/ballerinax/awslambda/tree/master/awslambda-examples/examples/aws-lambda-deployment

• [Kubernetes] (https://ballerina.io/learn/by-example/kubernetes-deployment.html): Icon should link to https://github.com/ballerinax/kubernetes/tree/master/kubernetes-extension-examples/examples/kubernetes-deployment

• [Openshift] (https://ballerina.io/learn/by-example/openshift-deployment.html): Icon should link to https://github.com/ballerinax/kubernetes/tree/master/kubernetes-extension-examples/examples/openshift-deployment

• [Docker] (https://ballerina.io/learn/by-example/docker-deployment.html): Icon should link to https://github.com/ballerinax/docker/tree/master/docker-extension-examples/examples/docker-deployment

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, Browser, other environment details and versions:

Steps to reproduce:

Related Issues:

Can’t scroll the page horizontally

There's a duplicate list of archived Ballerina versions at https://ballerina.io/downloads/archived

Description:
When you click on the 'Events' you will be redirected to following page which shows

Home>>Learn>>Events

And when you click on the Learn, nothing happens.

Description:
1.In the quick tour documentation ballerina run hello_service.bal is not highlighted as a command.
2.Step 9 says only add and subtract are implemented, but all 4 functions have been already implemented.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
When you Google search for a simple example such as "Restful services in Ballerina" it shows a guide "RESTful Service - Ballerina.io" as the topmost result. But when you click on it redirects to the Ballerina home page. This is the case for most of the guides.

We should redirect it to the correct page, since this could have a significant impact on user experience.

Affected Versions:
Ballerina 1.0.0

Description:
This is to revamp and improve the current structure of the Quick Tour[1].

[1] https://ballerina.io/learn/quick-tour/

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, Browser, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
No Runtime Layer for 1.0 yet?

Apparently there is no matching runtime layer for Ballerina 1.0 available yet? At least it is not mentioned on the AWS Layers page: https://v1-0.ballerina.io/deployment/aws-lambda/

I can confirm that 1.0 code does not work with 0.99x layers.

Although we have a list of archived Ballerina verions at https://ballerina.io/downloads/archived, download links are only provided for the signature files of the distributions, not for the actual installers/distributions.

Description:
Previous version of ballerina would allow for importing jdbc jars into a kubernetes based project via @kubernetes:Deployment:

copyFiles:[
        {
            target:"/ballerina/runtime/bre/lib/mssql-jdbc-6.4.0.jre8.jar",
            sourceFile:"./conf/mssql-jdbc-6.4.0.jre8.jar"
        }
    ]

With ballerina 1.x.x versions moving away from the base ballerina image and towards an openjdk base image, users will have to create a module in the project and place the jdbc jar in that module for it to be usable in the docker image.

Reference: https://stackoverflow.com/questions/58228578/ballerina-docker-image-with-mysql-driver-how-to/58230137#58230137

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

A lot of people tend to google for finding API docs etc. related to Ballerina. And most of the top results tend to be old links which don't exist anymore and hence returns 404. Is there something we can do about this, to ensure the old pages are removed from the indexing? Or does this have to happen in time?

Description:

Is this supported for the IntelliJ plugin?
if so, is there any documentation?

Steps to reproduce:

Affected Versions:

OS, DB, other environment details and versions:
Mac, JDK 1.8
Related Issues (optional):

Suggested Labels (optional):

Suggested Assignees (optional):
@NipunaRanasinghe

Description:
$subject with the learn page [1]

Shall we rename that to "Quick Tour"?

[1] https://v1-0.ballerina.io/learn/

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
We need to replace the "Start" and "Watch" text with the respective icons in [1].

[1] https://ballerina.io/learn/quick-tour/

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, Browser, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
We need to improve the structure of the Learn page.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, Browser, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
We have more broken links to be fixed in API Docs[1].

[1] https://ballerina.io/learn/api-docs/ballerina/auth/errors.html#Error

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, Browser, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
Add the diagram to map inbound auth mechanisms to outbound authentication mechanisms and explain all possible combinations that make sense.

Related to how-to-write-secure-ballerina-code.md

Description:
After selecting a tab and change the sample, it's always going to the "Source" tab. Need to persist users selection.

Affected Product Version:
v0.9.016

OS, DB, other environment details and versions:
All

Steps to reproduce:
Refer the screenshot above

Description:
If you double-click (on a Mac) to select the block then paste it into a terminal session you get:

laptop:~ phil$ $ ballerina new quick-tour
-bash: $: command not found

This can quickly become irritating as it takes time to remove and is a bad user experience to the point where I've stopped using several sites that do this.

Docker, for instance, doesn't do it and their site is exemplary.

Steps to reproduce:
Check ay Ballerina By Example's run command exmaple
Affected Versions:

OS, DB, other environment details and versions:

Related Issues (optional):

Suggested Labels (optional):

Suggested Assignees (optional):

Description:
There are many screen recordings added to the website (mainly in the Tooling section). We can compress and reduce the size of them so that it will have an impact in improving the loading time of the website.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
Originally reported here. https://news.ycombinator.com/item?id=20926602

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
Need to update the DB with some realistic information data.

Affected Product Version:
v0.9.016

OS, DB, other environment details and versions:
All

Steps to reproduce:

1. Navigate to home page
2. On the playground widget select Data Service and click "Run"

Description:
Is it possible to have some comments explaining type system statements we have in https://ballerina.io/philosophy/?

I think if we can reduce font size, have comments explaining types and have some line breaks this can be much more readable.

Something like this,

Currently the way we have organized BBEs page seems to be kind of a mix of language/std lib concepts and how-to kind of examples. In this style of organization, some of the important aspects which we need to illustrate through the examples either gets lost or buried in some obscure example.

For example, if we take records, we have a separate heading under which we have several examples demonstrating various aspects of records. But examples regarding how records can and should be used in practice are scattered across other examples. Record to JSON conversion and vice versa is under the JSON/XML section and how to access and deal with optional fields in records is in "optional field access" under value/type operations. For someone just starting to learn the language, it might not be immediately apparent that these different examples are interconnected.

Another instance I came across is handling/manipulating files. This info seems to be missing altogether in BBEs. There's a section on I/O, but those examples are organized in such a way that they explain each of the features offered by the I/O library.

Description:
When scrolling the code in example block on home page, the entire page scrolls as well. This is a bit distracting. See below,

OS, DB, other environment details and versions:

Firefox 59.0.2

Description:
When I open the page ballerina.io on iPhone then I can not (easy) scroll through the code and read it. sometimes it goes into editor and zoom in. Pages chrashing and iOS Safari read the page

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:
iPhone 6S+
iOS11.4.1
Safari

Steps to reproduce:

• open ballerina.io on iPhone
• select an different example in playground
• not the full code is visible
• try to scroll through the source code
• it scrolls only sometimes one line per scroll
• many times a swipe has no effecr
• many times a swipe result placing cursor in code and going to editor mode (zoom in + show keyboard) - you struggle hard to zoom out and exit the editor mode
• many times full page crashing and page is reloaded

Quick Fix
One very helpfullquick fix can be: autoexpand the code section to show the full code after an change to a different example. Then there is no need to scroll through the code.

Related Issues:

Description:
When navigating from the Visual Studio Code Plugin web page to the Run and Debug web page, the loaded page URL[1] contains an additional slash in it. Furthermore when in Tools and IDEs page[2], when navigating to VSCode plugin or InteliJ plugin page, it returns a 404.

[1] - https://ballerina.io/learn/tools-ides//vscode-plugin/run-and-debug
[2] - https://ballerina.io/learn/tools-ides/

In the "Build, test & run programs" section it says the following:

These everyday commands are for the very basics of being a Ballerina programmer: from compiling and running programs to testing them to generating their documentation.

This reads odd. Better if we can rephrase this.

There are multiple other places where the content needs to be improved. And came across a typo or two as well.

At the moment only the FAQ page discusses about CI/CD in Ballerina. But it would be great to have some doc which explains how to achieve this for at least certain scenarios. Mainly, because nowadays CI/CD is a must for any new project.

Description:

Need to fix dependency vulnerability issues. See the log below,

[INFO] --- exec-maven-plugin:1.5.0:exec (npm install) @ ballerina-playground-widget ---
npm WARN [email protected] requires a peer of ajv@^6.0.0 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of eslint-plugin-jsx-a11y@^6.0.2 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of webpack@^4.5.0 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of react@^15.4.2 but none is installed. You must install peer dependencies yourself.
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})

audited 17082 packages in 26.119s
found 12 vulnerabilities (8 moderate, 4 high)
 run `npm audit fix` to fix them, or `npm audit` for details
[INFO]
[INFO] --- exec-maven-plugin:1.5.0:exec (install deps for composer) @ ballerina-playground-widget ---
npm WARN The package rimraf is included as both a dev and production dependency.
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})

audited 11025 packages in 27.128s
found 341 vulnerabilities (212 low, 105 moderate, 22 high, 2 critical)
 run `npm audit fix` to fix them, or `npm audit` for details

Affected Product Version:
0.980.0

OS, DB, other environment details and versions:
Windows

Steps to reproduce:
run mvn install from the website folder

Refer to the screenshot below

The text should read ballerina/lang.array

Description:
Its good if the following can be updated on the document to support ubuntu platforms
1.The document should state that the docker commands has to be run as sudo

2.The command [a] can also be run without -p 9090:9090. If we run the command on the document we get an error as[b]. We could mention that -p is optional
[a] sudo docker run -d -p 9090:9090 registry.hub.docker.com/helloworld:v1.0

[b] Error starting userland proxy: listen tcp 0.0.0.0:9090: bind: address already in use.

3.The output from[c] is shown in the document as ID:991212870376534016 but it should be Hello Ballerina!. Please check this point again

[c]curl -d "Hello Ballerina" -X POST localhost:9090

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:

1. $Subject when try to download from here https://v1-0.ballerina.io/downloads/

Environment:

Chrome

Description:
Once a Google search is done for "Ballerina JDBC" we still get the outdated URL as the top-most result.

Instead of the "ballerinax/jdbc" module, now we have the "ballerinax/java.jdbc" module. Therefore, we need to redirect this [1] to [2].

[1] https://ballerina.io/learn/api-docs/ballerinax/jdbc.html
[2] https://ballerina.io/learn/api-docs/ballerina/java.jdbc/index.html

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, Browser, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
Currently Ballerina test learn page does not explain about how the services behaves during testing. Also the current implementation is different from how the services are started in previous releases ( behavior has been changed in 0.9... release ) thus the articles and blogs explain the previous behavior.

We need to update the Ballerina test learn page so that users can refer and understand how services behaves during testing.

Affected Product Version:
1.0.0

Description:
API docs are listed under Reference Documentation in the https://ballerina.io/learn page.

Currently navigating to API docs is not straightforward, unless known where to look, given that the Table of Contents also contains only high level headings. Could this be improved, maybe by providing a nested ToC indicating sub-headings such as API docs, language specification, etc. at first glance?

Convert the Training doc in to MD and use it as the base.
https://docs.google.com/document/d/14YhJnna5edKwia8c_2KZthQictqEO5SX8VHUgmWogI8/edit

Description:
A small example on how to run a test would be useful within the guide. Ex for running the test with hello-world sample we can provide the steps

Description:

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, Browser, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
In all of the following screenshots, there are multiple instances where it's said to create a new file or folder by right clicking on a folder. Creating a new file by this method is not possible in linux and also more importantly, it's unclear whether the new file or folder should be created inside the existing folder or at the same level.
Screenshot 1:

Screenshot 2:

Screenshot 3:

Therefore my suggestion is that it would be better if it is specified in a clearer way such as "Create a new file inside the calculator folder" or "Create a new folder on the same level as calculator folder".
Example solution:

OS, DB, other environment details and versions:
Ubuntu 18.04.3

The link in the website to the Slack page is https://ballerina.io/community/slack/

The above link returns a 404 due to the trailing slash.

Need to do $subject due to the following PR: ballerina-platform/ballerina-lang#19164

Description:
The search functionality which was very useful for navigating through the website is not there in the 1.0.0 website. It would be very nice to have it back.

Affected Product Version:
JBallerina 1.0.0

Description:
$subject in the each of b.io page as it redirects to non-existing github branch [1]

[1] https://github.com/ballerina-platform/ballerina-www/tree/1.0 rc1/website/two-column-pages/docs/

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:
While in the Api-Docs > ballerinax/kubernetes > DeploymentConfiguration the link for env data types

map<string\|kubernetes:FieldRef\|kubernetes:SecretKeyRef\|kubernetes:ResourceFieldRef\|kubernetes:ConfigMapKeyRef>
-- | --

links to a 404 -> here
Change builtin.html#map to primitive-types.html#map

Line reference: https://github.com/ballerina-platform/ballerina-www/blob/a4882a3ca4e9bb7dbc1f656d80193da6bcb064d1/api-docs/docs/ballerinax/kubernetes.html#L2016

I was going to do a PR, but unsure if that's the desired path for the fix. 😄

Suggested Labels:
Type/UX

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Description:

We don't have a "Tools and IDEs" page now. But the VScode help page [1] and IDEA plugin help page [2] (Which are linked from learn page [3]) are shown as sub pages of "Tools and IDEs"

[1] https://v1-0.ballerina.io/learn/tools-ides/vscode-plugin/
[2] https://v1-0.ballerina.io/learn/tools-ides/intellij-plugin/
[3] https://v1-0.ballerina.io/learn/

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues: