ballerina-platform / ballerina-dev-website

Dev version of the ballerina.io website
Apache License 2.0
157 stars 178 forks source link

Introduce an `advanced topics` section to the ballerina website #9049

Open gayaldassanayake opened 6 months ago

gayaldassanayake commented 6 months ago

Description

Certain advanced topics are not required for any beginner or intermediate users, but are helpful for the advanced users.

Following are such examples.

For some of these cases,

Related website/documentation area

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

Describe the problem(s)

Not having official documentation can cause time-wasting and confusion for internal developers. External developers may not be able to find these unofficial how-to guides, hence might not be able to accomplish desired tasks entirely.

Describe your solution(s)

Introduce a section of documentation for advanced users. For this, we need to look at how other programming languages/ technologies have documented and presented such topics to the users.

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.

gayaldassanayake commented 1 month ago

Had an offline discussion regarding this with @anupama-pathirage. All these topics are mostly used by internal developers. As an initial step, these documentations will be added under https://github.com/ballerina-platform/ballerina-lang/tree/master/docs.

Related design doc - https://docs.google.com/document/d/145VFCbfUZxB6HZ3RHKgHEcKehXqRvFEZHNqeG--tYt8/edit?usp=sharing