From 5526b3798aa1b623dce4271e506ccaf6f4dc5fd3 Mon Sep 17 00:00:00 2001 From: Janaka Sandaruwan Date: Wed, 1 Nov 2023 14:51:40 +0530 Subject: [PATCH] Update readme --- greeting-service-go/README.md | 12 +++++++----- hello-world-go-task/readme.md | 12 +++++++----- hello-world-go-webapp/README.md | 12 +++++++----- hello-world-java-task/readme.md | 9 +++++---- hello-world-nodejs-task/readme.md | 10 ++++++---- hello-world-php-service/README.md | 10 ++++++---- hello-world-php-task/readme.md | 10 ++++++---- hello-world-php-webapp/README.md | 10 ++++++---- hello-world-php-webapp/metadata.yaml | 2 +- hello-world-python-task/readme.md | 10 ++++++---- hello-world-ruby-service/README.md | 10 ++++++---- hello-world-ruby-task/readme.md | 12 +++++++----- hello-world-ruby-webapp/README.md | 10 ++++++---- product-management-service/README.md | 10 ++++++---- reading-books-list-service-nodejs/README.md | 10 ++++++---- reading-books-list-service-python/readme.md | 10 ++++++---- 16 files changed, 94 insertions(+), 65 deletions(-) diff --git a/greeting-service-go/README.md b/greeting-service-go/README.md index 44f52391..91fb89e4 100644 --- a/greeting-service-go/README.md +++ b/greeting-service-go/README.md @@ -12,6 +12,9 @@ Note: The following file paths are relative to the path /go/greeter | .choreo/endpoints.yaml | Choreo-specific configuration that provides information about how Choreo exposes the service. | | openapi.yaml | OpenAPI contract of the greeter service. This is needed to publish our service as a managed API. This openapi.yaml file is referenced by the .choreo/endpoints.yaml. | +### Prerequisites +1. Fork the repositoy + ## Deploy Application Please refer to the Choreo documentation under the [Develop a REST API](https://wso2.com/choreo/docs/develop-components/develop-services/develop-a-rest-api/#step-1-create-a-service-component-from-a-dockerfile) section to learn how to deploy the application. @@ -19,8 +22,7 @@ Please refer to the Choreo documentation under the [Develop a REST API](https:// You can select either Docker or Go as buildpacks. Fill as follow according to selected Buildpack. 1. Select `Service` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Go` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Go` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -31,10 +33,10 @@ You can select either Docker or Go as buildpacks. Fill as follow according to se | **Branch** | **`main`** | | **Buildpack** | `Go` | | **Select Go Project Directory** | hello-world-go-task | - | **Select Language Version** | 1.x | + | **Language Version** | 1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component ## Execute the Sample Locally diff --git a/hello-world-go-task/readme.md b/hello-world-go-task/readme.md index 3e150c90..0a832513 100644 --- a/hello-world-go-task/readme.md +++ b/hello-world-go-task/readme.md @@ -2,13 +2,15 @@ Sample for Hello World task. Print "Hello World" when run the main.go +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Manual Task` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Go` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Go` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -19,10 +21,10 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Branch** | **`main`** | | **Buildpack** | Go| | **Select Go Project Directory** | hello-world-go-task | - | **Select Language Version** | 1.x | + | **Language Version** | 1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component ## Execute the Sample Locally diff --git a/hello-world-go-webapp/README.md b/hello-world-go-webapp/README.md index 253f4070..c288958b 100644 --- a/hello-world-go-webapp/README.md +++ b/hello-world-go-webapp/README.md @@ -2,13 +2,15 @@ Sample for Hello World web app. +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Web Application` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Go` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Go` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -19,11 +21,11 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Branch** | **`main`** | | **Buildpack** | Go| | **Select Go Project Directory** | hello-world-go-task | - | **Select Language Version** | 1.x | + | **Language Version** | 1.x | | **Port** | 8080| -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component ## Execute the Sample Locally diff --git a/hello-world-java-task/readme.md b/hello-world-java-task/readme.md index 837769bd..4f1450f5 100644 --- a/hello-world-java-task/readme.md +++ b/hello-world-java-task/readme.md @@ -2,14 +2,15 @@ Sample for Hello World task. Print "Hello World" +### Prerequisites +1. Fork the repositoy ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Manual Task` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Java` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Java` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -22,8 +23,8 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Go Project Directory** | hello-world-java-task | | **Select Language Version** | 8 | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component Here, we have specify the entrypoint in the `Procfile` diff --git a/hello-world-nodejs-task/readme.md b/hello-world-nodejs-task/readme.md index 968b926b..f6fd87b9 100644 --- a/hello-world-nodejs-task/readme.md +++ b/hello-world-nodejs-task/readme.md @@ -2,13 +2,15 @@ Sample for Hello World task. Print "Hello World" +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Manual Task` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `NodeJs` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `NodeJs` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -21,5 +23,5 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Go Project Directory** | hello-world-nodejs-task | | **Select Language Version** | 16.x.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/hello-world-php-service/README.md b/hello-world-php-service/README.md index a92b13c5..1eacef4f 100644 --- a/hello-world-php-service/README.md +++ b/hello-world-php-service/README.md @@ -2,13 +2,15 @@ Sample for Hello World service. +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Service` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `PHP` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `PHP` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -21,5 +23,5 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Go Project Directory** | hello-world-php-service| | **Select Language Version** | 8.1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/hello-world-php-task/readme.md b/hello-world-php-task/readme.md index ca5179ae..56b4785d 100644 --- a/hello-world-php-task/readme.md +++ b/hello-world-php-task/readme.md @@ -2,13 +2,15 @@ Sample for Hello World task. Print "Hello World" +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Manual Task` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `PHP` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `PHP` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -21,5 +23,5 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Go Project Directory** | hello-world-php-task | | **Select Language Version** | 1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/hello-world-php-webapp/README.md b/hello-world-php-webapp/README.md index d9c90e54..5f6dc324 100644 --- a/hello-world-php-webapp/README.md +++ b/hello-world-php-webapp/README.md @@ -2,13 +2,15 @@ Sample for Hello World web app. +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Web Application` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `PHP` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `PHP` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -21,5 +23,5 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Go Project Directory** | hello-world-php-webapp | | **Select Language Version** | 8.1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/hello-world-php-webapp/metadata.yaml b/hello-world-php-webapp/metadata.yaml index b838ab67..c473e376 100644 --- a/hello-world-php-webapp/metadata.yaml +++ b/hello-world-php-webapp/metadata.yaml @@ -5,6 +5,6 @@ buildPreset: php repositoryUrl: https://github.com/wso2/choreo-samples/ componentPath: /hello-world-php-webapp thumbnailPath: /hello-world-php-webapp/icon.png -documentationPath: /hello-world-php-webapp/readme.md +documentationPath: /hello-world-php-webapp/README.md tags: - Web Application diff --git a/hello-world-python-task/readme.md b/hello-world-python-task/readme.md index b5cce6a8..e740f0e9 100644 --- a/hello-world-python-task/readme.md +++ b/hello-world-python-task/readme.md @@ -2,13 +2,15 @@ Sample for Hello World task. Print "Hello World" when run the main.py +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Manual Task` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Python` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Python` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -21,5 +23,5 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Go Project Directory** | hello-world-python-task | | **Select Language Version** | 1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/hello-world-ruby-service/README.md b/hello-world-ruby-service/README.md index c5e13aae..bfdf431a 100644 --- a/hello-world-ruby-service/README.md +++ b/hello-world-ruby-service/README.md @@ -2,13 +2,15 @@ Sample for Hello World service. This API responds with a "Hello World" message when called, making it an excellent starting point for beginners and a handy tool for testing APIs with Ruby. +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Service` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Ruby` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Ruby` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -21,5 +23,5 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Go Project Directory** | hello-world-ruby-webapp | | **Select Language Version** | 3.1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/hello-world-ruby-task/readme.md b/hello-world-ruby-task/readme.md index b7df3747..1eee86e1 100644 --- a/hello-world-ruby-task/readme.md +++ b/hello-world-ruby-task/readme.md @@ -2,13 +2,15 @@ Sample for Hello World task. Print "Hello World" +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Manual Task` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Ruby` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Ruby` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -19,7 +21,7 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Branch** | **`main`** | | **Buildpack** | Ruby| | **Select Go Project Directory** | hello-world-ruby-task | - | **Select Language Version** | 1.x | + | **Select Language Version** | 3.1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/hello-world-ruby-webapp/README.md b/hello-world-ruby-webapp/README.md index 1dd69254..4b3d716b 100644 --- a/hello-world-ruby-webapp/README.md +++ b/hello-world-ruby-webapp/README.md @@ -2,13 +2,15 @@ Sample for Hello World web app. +### Prerequisites +1. Fork the repositoy + ## Getting started Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Web Application` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Ruby` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Ruby` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -22,5 +24,5 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Language Version** | 3.1.x | | **Port** | 8080| -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component diff --git a/product-management-service/README.md b/product-management-service/README.md index b3556743..eca7afde 100644 --- a/product-management-service/README.md +++ b/product-management-service/README.md @@ -12,13 +12,15 @@ Note: The following file paths are relative to the path /java/rest-api/ | .choreo/endpoints.yaml | Choreo-specific configuration that provides information about how Choreo exposes the service. | | openapi.yaml | OpenAPI contract of the service. This is needed to publish our service as a managed API. This openapi.yaml file is referenced by the .choreo/endpoints.yaml. | +### Prerequisites +1. Fork the repositoy + ## Deploy Application Please refer to the Choreo documentation under the [Develop an Application with Buildpacks](https://wso2.com/choreo/develop-components/deploy-an-application-with-buildpacks) to learn how to deploy the application. 1. Select `Service` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Java` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Java` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -31,8 +33,8 @@ Please refer to the Choreo documentation under the [Develop an Application with | **Select Java Project Directory** | product-management-service | | **Select Language Version** | 17 | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component The [endpoints.yaml](.choreo/endpoints.yaml) file contains the endpoint configurations that are used by the Choreo to expose the service. diff --git a/reading-books-list-service-nodejs/README.md b/reading-books-list-service-nodejs/README.md index e923915e..6c7e309e 100644 --- a/reading-books-list-service-nodejs/README.md +++ b/reading-books-list-service-nodejs/README.md @@ -12,6 +12,9 @@ Note: The following file paths are relative to the path /nodejs/rest-api/ | .choreo/endpoints.yaml | Choreo-specific configuration that provides information about how Choreo exposes the service. | | openapi.yaml | OpenAPI contract of the service. This is needed to publish our service as a managed API. This openapi.yaml file is referenced by the .choreo/endpoints.yaml. | +### Prerequisites +1. Fork the repositoy + ## Deploy Application Please refer to the Choreo documentation under the [Develop a REST API](https://wso2.com/choreo/docs/develop-components/develop-services/develop-a-rest-api/#step-1-create-a-service-component-from-a-dockerfile) section to learn how to deploy the application. @@ -19,8 +22,7 @@ Please refer to the Choreo documentation under the [Develop a REST API](https:// You can select either Docker or Go as buildpacks. Fill as follow according to selected Buildpack. 1. Select `Service` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `NodeJs` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `NodeJs` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -33,8 +35,8 @@ You can select either Docker or Go as buildpacks. Fill as follow according to se | **Select Go Project Directory** | reading-books-list-service-nodejs| | **Select Language Version** | 18.x.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component ## Execute the Sample Locally diff --git a/reading-books-list-service-python/readme.md b/reading-books-list-service-python/readme.md index 3fca47f9..e643a1c8 100644 --- a/reading-books-list-service-python/readme.md +++ b/reading-books-list-service-python/readme.md @@ -12,6 +12,9 @@ Note: The following file paths are relative to the path /python/rest-api/ | .choreo/endpoints.yaml | Choreo-specific configuration that provides information about how Choreo exposes the service. | | openapi.yaml | OpenAPI contract of the service. This is needed to publish our service as a managed API. This openapi.yaml file is referenced by the .choreo/endpoints.yaml. | +### Prerequisites +1. Fork the repositoy + ## Deploy Application Please refer to the Choreo documentation under the [Develop a REST API](https://wso2.com/choreo/docs/develop-components/develop-services/develop-a-rest-api/#step-1-create-a-service-component-from-a-dockerfile) section to learn how to deploy the application. @@ -19,8 +22,7 @@ Please refer to the Choreo documentation under the [Develop a REST API](https:// You can select either Docker or Go as buildpacks. Fill as follow according to selected Buildpack. 1. Select `Service` Card from Component Creation Wizard -2. Fork the repositoy -3. Select `Python` as the buildpack. Fill as follow according to selected Buildpack. +2. Select `Python` as the buildpack. Fill as follow according to selected Buildpack. | **Field** | **Description** | |-----------------------|-----------------------------------------------| @@ -33,8 +35,8 @@ You can select either Docker or Go as buildpacks. Fill as follow according to se | **Select Go Project Directory** | reading-books-list-service-python| | **Select Language Version** | 3.1.x | -4. Click Create. Once the component creation is complete, you will see the component overview page. -5. Deploy the created component +3. Click Create. Once the component creation is complete, you will see the component overview page. +4. Deploy the created component The [endpoints.yaml](.choreo/endpoints.yaml) file contains the endpoint configurations that are used by the Choreo to expose the service.