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

Restructure and update the documentation #206

Merged
merged 23 commits into from
Mar 21, 2024

Conversation

RDPerera
Copy link
Member

@RDPerera RDPerera commented Nov 23, 2023

Description

Update Module.md and README.md to new structure.

Fixes ballerina-platform/ballerina-library#6206
Related to ballerina-platform/ballerina-library#5807

Related Pull Requests (remove if not relevant)

  • Pull request 1
  • Pull request 2

One line release note:

  • One line describing the feature/improvement/fix made by this PR

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Ballerina Version:
  • Operating System:
  • Java SDK:

Checklist:

Security checks

README.md Show resolved Hide resolved
@ayeshLK
Copy link
Member

ayeshLK commented Nov 23, 2023

Do we have to commit ballerina/.DS_Store file ?

@ayeshLK
Copy link
Member

ayeshLK commented Nov 23, 2023

In the Module.md the package import statement can be rephrased as this:

import ballerinax/asb;

@RDPerera RDPerera self-assigned this Nov 23, 2023
@RDPerera
Copy link
Member Author

In the Module.md the package import statement can be rephrased as this:

import ballerinax/asb;

Addressed in b5bfa30

@RDPerera
Copy link
Member Author

Do we have to commit ballerina/.DS_Store file ?

No. It was a mistake. Addressed in b5bfa30

@RDPerera RDPerera requested a review from ayeshLK January 1, 2024 04:45
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
codecov.yml Outdated Show resolved Hide resolved
RDPerera and others added 2 commits March 20, 2024 16:15
Co-authored-by: Ayesh Almeida <77491511+ayeshLK@users.noreply.github.com>
ballerina/Module.md Show resolved Hide resolved
ballerina/Module.md Show resolved Hide resolved
ballerina/Module.md Show resolved Hide resolved
ballerina/Module.md Show resolved Hide resolved
Copy link
Contributor

@NipunaRanasinghe NipunaRanasinghe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@RDPerera RDPerera merged commit e9b2b15 into ballerina-platform:main Mar 21, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restructure and update the documentation
3 participants