diff --git a/adapter/README.md b/adapter/README.md index a25ebac91..14059fbc4 100644 --- a/adapter/README.md +++ b/adapter/README.md @@ -27,7 +27,7 @@ The following should be installed in your dev machine. gradle build ``` - This will build go binary and pack into a docker image named as `adapter:0.0.1-SNAPSHOT`. + This will build go binary and pack into a docker image named as `adapter:1.0.0-SNAPSHOT`. 3. If you ran into any issue first check whether the [prerequisites](#prerequisites) are satisfied. diff --git a/common-controller/internal/operator/README.md b/common-controller/internal/operator/README.md index d7be8458f..d5482cf4d 100644 --- a/common-controller/internal/operator/README.md +++ b/common-controller/internal/operator/README.md @@ -2,7 +2,7 @@ // TODO(user): Add simple overview of use/purpose ## Description -// TODO(user): An in-depth paragraph about your project and overview of use +// TODO(user): An in-depth paragraph about your project and overview of use. ## Getting Started You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. diff --git a/gateway/enforcer/README.md b/gateway/enforcer/README.md index 29138cfa1..2122a1b3a 100644 --- a/gateway/enforcer/README.md +++ b/gateway/enforcer/README.md @@ -33,7 +33,7 @@ The following should be installed in your development machine. + value: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5006 -Dhttpclient.hostnameVerifier=AllowAll -Xms512m -Xmx512m -XX:MaxRAMFraction=2 ``` -2. Start WSO2 APK. +2. Start WSO2 API Platform for K8s. 3. Port forward the port 5006. diff --git a/gateway/router/README.md b/gateway/router/README.md index 97a9033f0..a1695c87e 100644 --- a/gateway/router/README.md +++ b/gateway/router/README.md @@ -1 +1,3 @@ -## Router \ No newline at end of file +## Router + +APK router. \ No newline at end of file diff --git a/idp/idp-domain-service/README.md b/idp/idp-domain-service/README.md index 27a7fd5ee..8956df918 100644 --- a/idp/idp-domain-service/README.md +++ b/idp/idp-domain-service/README.md @@ -1,5 +1,7 @@ ## IDP Domain Service +APK IDP Domain Service. + # Functionalities. 1. Generate Token. diff --git a/idp/idp-ui/README.md b/idp/idp-ui/README.md index 974f0a7c9..0657a1ee9 100644 --- a/idp/idp-ui/README.md +++ b/idp/idp-ui/README.md @@ -1,3 +1,5 @@ +APK IDP UI + 1. cd idp/idp-ui 2. npm install 3. npm run startDev diff --git a/ratelimiter/README.md b/ratelimiter/README.md index a8ebb8893..6d97e230c 100644 --- a/ratelimiter/README.md +++ b/ratelimiter/README.md @@ -1,5 +1,7 @@ # Rate Limiter +APK Rate Limiter. + ## Dev Guide ### Health Check diff --git a/runtime/config-deployer-service/README.md b/runtime/config-deployer-service/README.md index ccd625cc7..b835eb5b3 100644 --- a/runtime/config-deployer-service/README.md +++ b/runtime/config-deployer-service/README.md @@ -1,5 +1,7 @@ ## Config Deployer Service +APK Config Deployer Service. + # Functionalities. 1. Generate APK configuration (api.apk-conf) from given OAS definition.