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

Introduce an advanced topics section to the ballerina website #9049

Open
gayaldassanayake opened this issue May 29, 2024 · 1 comment
Open
Assignees
Labels
Area/LearnPages Issues related to all the pages of the Learn section. Category/Content All written content related issues (Technical content, english language etc) Kind/DevTools Type/Improvement Improvements required on the website.

Comments

@gayaldassanayake
Copy link
Contributor

Description

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

Following are such examples.

  • Project API
  • Compiler Plugins
  • Bal tool creation
  • Tool integration with package build
  • Creating custom rules for bal scan tool

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 gayaldassanayake added the Type/Improvement Improvements required on the website. label May 29, 2024
@anupama-pathirage anupama-pathirage added Area/LearnPages Issues related to all the pages of the Learn section. Category/Content All written content related issues (Technical content, english language etc) labels Aug 20, 2024
@anuruddhal anuruddhal added this to the Documentation - M6 milestone Sep 13, 2024
@gayaldassanayake
Copy link
Contributor Author

gayaldassanayake commented Oct 4, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/LearnPages Issues related to all the pages of the Learn section. Category/Content All written content related issues (Technical content, english language etc) Kind/DevTools Type/Improvement Improvements required on the website.
Projects
Status: Backlog
Development

No branches or pull requests

3 participants