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

Add the README.md as the default package documentation for libraries #7404

Closed
44 tasks done
TharmiganK opened this issue Nov 22, 2024 · 2 comments
Closed
44 tasks done

Comments

@TharmiganK
Copy link
Contributor

TharmiganK commented Nov 22, 2024

Description

With update 11, the default package documentation has changed to README.md file[1]. This change is backward compatible. But still there is an error printed for the libraries which has Package.md/Module.md files:

WARNING [log] The default file for package documentation is changed to README.md. If you prefer to use the Package.md, add the following line under the '[package]' section in your Ballerina.toml file:
        readme = "Package.md"

[1] ballerina-platform/ballerina-spec#1256

As a solution the Package.md/Module.md files should be replaced by a README.md file. This has to be done for all the libraries

  • io
  • java.arrays
  • math.vector
  • time
  • url
  • avro
  • constraint
  • crypto
  • log
  • os
  • persist
  • protobuf
  • random
  • task
  • xslt
  • cache
  • data.xmldata
  • data.yaml
  • file
  • ftp
  • ldap
  • mime
  • tcp
  • udp
  • uuid
  • auth
  • data.csv
  • data.jsondata
  • edi
  • email
  • jwt
  • mqtt
  • oauth2
  • toml
  • yaml
  • http
  • grpc
  • soap
  • transaction
  • websocket
  • websub
  • websubhub
  • graphql
  • sql

Version

Ballerina SwanLake Update 11

@NipunaRanasinghe
Copy link
Contributor

NipunaRanasinghe commented Nov 22, 2024

Need to do the same change for all the ballerinax modules (connectors) as well.

This was referenced Nov 25, 2024
This was referenced Nov 25, 2024
@NipunaRanasinghe NipunaRanasinghe self-assigned this Nov 25, 2024
@daneshk
Copy link
Member

daneshk commented Jan 28, 2025

This task is done. Hence closing the issue.

@daneshk daneshk closed this as completed Jan 28, 2025
@github-project-automation github-project-automation bot moved this from In Progress to Done in Ballerina Team Main Board Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

3 participants