From 6f66f8bf70fa0a2da994d1e1f43eedc36ffcb7dd Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Mon, 25 Nov 2024 16:35:39 +0530 Subject: [PATCH] Make README.md as the default package documentation --- ballerina/Package.md | 25 ------------------- ballerina/{Module.md => README.md} | 0 .../mockextension/{Module.md => README.md} | 0 3 files changed, 25 deletions(-) delete mode 100644 ballerina/Package.md rename ballerina/{Module.md => README.md} (100%) rename ballerina/modules/mockextension/{Module.md => README.md} (100%) diff --git a/ballerina/Package.md b/ballerina/Package.md deleted file mode 100644 index 9657dc5..0000000 --- a/ballerina/Package.md +++ /dev/null @@ -1,25 +0,0 @@ -## Package Overview - -The `observe` library is one of the standard library packages of the Ballerina language. -It provides APIs for observing ballerina code. - -## Officially supported Observability Providers - -Please check the corresponding package documentation for instructions on enabling different Observability providers. - -### Metrics Reporters -- [Choreo](https://central.ballerina.io/ballerinax/choreo) -- [Prometheus](https://central.ballerina.io/ballerinax/prometheus) - -### Tracing Providers -- [Choreo](https://central.ballerina.io/ballerinax/choreo) -- [Jaeger](https://central.ballerina.io/ballerinax/jaeger) - -## Report Issues - -To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina standard library parent repository - -## Useful Links - -* Chat live with us via our Discord server. -* Post all technical questions on Stack Overflow with the #ballerina tag. diff --git a/ballerina/Module.md b/ballerina/README.md similarity index 100% rename from ballerina/Module.md rename to ballerina/README.md diff --git a/ballerina/modules/mockextension/Module.md b/ballerina/modules/mockextension/README.md similarity index 100% rename from ballerina/modules/mockextension/Module.md rename to ballerina/modules/mockextension/README.md