From 2d1c9b853812be8a6fcd06e19b021d19927b3fef Mon Sep 17 00:00:00 2001 From: KamalikaSene Date: Fri, 5 Jul 2024 13:33:21 +0530 Subject: [PATCH 1/3] Add width to images in documentation --- README.md | 10 +++++----- ballerina/Module.md | 10 +++++----- ballerina/Package.md | 14 +++++++------- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 9725fcb..491aadc 100644 --- a/README.md +++ b/README.md @@ -19,25 +19,25 @@ Follow these steps to create a Discord developer account. ### Step 1: Login to Discord developer page -Discord Dev Page +Discord Dev Page Visit [Discord developer portal](https://discord.com/login?redirect_to=%2Fdevelopers) by logging into your Discord account. If you do not have a Discord account already, [create a new discord account](https://discord.com/login) by clicking on the `Register` hyperlink below the `Log In` button when opening the Discord developer page. -Create Discord Account +Create Discord Account Complete the account creation process by including the relavant information in the given fields. ### Step 2: Make a new Discord application -Make New Application +Make New Application Once in the Discord developer portal is open, click on the `New Application` button as displayed above to start the process. ### Step 3: Name the Discord Application -Name and Create the App +Name and Create the App 1. Proceed by giving the Discord Application a name and click on the terms of service. @@ -45,7 +45,7 @@ Once in the Discord developer portal is open, click on the `New Application` but ### Step 4: Obtain the Client ID and Client Secret -Obtain Client ID and Secret +Obtain Client ID and Secret Under the `OAuth2` section found on the left-sided list, locate the Client's Information as shown on the screen. To implement the functionalities provided by Discord's API, you will need the Client ID and Client Secret. diff --git a/ballerina/Module.md b/ballerina/Module.md index 65c73e2..a1ae11d 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -10,25 +10,25 @@ Follow these steps to create a Discord developer account. ### Step 1: Login to Discord developer page -Discord Dev Page +Discord Dev Page Visit [Discord developer portal](https://discord.com/login?redirect_to=%2Fdevelopers) by logging into your Discord account. If you do not have a Discord account already, [create a new discord account](https://discord.com/login) by clicking on the `Register` hyperlink below the `Log In` button when opening the Discord developer page. -Create Discord Account +Create Discord Account Complete the account creation process by including the relavant information in the given fields. ### Step 2: Make a new Discord application -Make New Application +Make New Application Once in the Discord developer portal is open, click on the `New Application` button as displayed above to start the process. ### Step 3: Name the Discord Application -Name and Create the App +Name and Create the App 1. Proceed by giving the Discord Application a name and click on the terms of service. @@ -36,7 +36,7 @@ Once in the Discord developer portal is open, click on the `New Application` but ### Step 4: Obtain the Client ID and Client Secret -Obtain Client ID and Secret +Obtain Client ID and Secret Under the `OAuth2` section found on the left-sided list, locate the Client's Information as shown on the screen. To implement the functionalities provided by Discord's API, you will need the Client ID and Client Secret. diff --git a/ballerina/Package.md b/ballerina/Package.md index d65a3fa..a1ae11d 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -10,25 +10,25 @@ Follow these steps to create a Discord developer account. ### Step 1: Login to Discord developer page - +Discord Dev Page -Visit [Discord developer portal](https://discord.com/login?redirect_to=%2Fdevelopers) by logging into your Discord account. +Visit [Discord developer portal](https://discord.com/login?redirect_to=%2Fdevelopers) by logging into your Discord account. If you do not have a Discord account already, [create a new discord account](https://discord.com/login) by clicking on the `Register` hyperlink below the `Log In` button when opening the Discord developer page. - +Create Discord Account Complete the account creation process by including the relavant information in the given fields. ### Step 2: Make a new Discord application - +Make New Application Once in the Discord developer portal is open, click on the `New Application` button as displayed above to start the process. -### Step 3: Name the Discord Application +### Step 3: Name the Discord Application - +Name and Create the App 1. Proceed by giving the Discord Application a name and click on the terms of service. @@ -36,7 +36,7 @@ Once in the Discord developer portal is open, click on the `New Application` but ### Step 4: Obtain the Client ID and Client Secret - +Obtain Client ID and Secret Under the `OAuth2` section found on the left-sided list, locate the Client's Information as shown on the screen. To implement the functionalities provided by Discord's API, you will need the Client ID and Client Secret. From c3d2c5a83d3b780b737010c74ec082f56cef3f65 Mon Sep 17 00:00:00 2001 From: KamalikaSene Date: Fri, 5 Jul 2024 13:45:41 +0530 Subject: [PATCH 2/3] Add main function to the documentation --- README.md | 4 +++- ballerina/Module.md | 4 +++- ballerina/Package.md | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 491aadc..40e8758 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,9 @@ Now, utilize the available connector operations. ### Return linked third-party accounts of the user ```ballerina - ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); +public function main() returns error? { + ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); +} ```` ### Step 4: Run the Ballerina application diff --git a/ballerina/Module.md b/ballerina/Module.md index a1ae11d..edce9db 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -78,7 +78,9 @@ Now, utilize the available connector operations. ### Return linked third-party accounts of the user ```ballerina - ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); +public function main() returns error? { + ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); +} ```` ### Step 4: Run the Ballerina application diff --git a/ballerina/Package.md b/ballerina/Package.md index a1ae11d..edce9db 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -78,7 +78,9 @@ Now, utilize the available connector operations. ### Return linked third-party accounts of the user ```ballerina - ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); +public function main() returns error? { + ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); +} ```` ### Step 4: Run the Ballerina application From 234a3298b411e5958e1852a25640e21418e0f03c Mon Sep 17 00:00:00 2001 From: Nipuna Ransinghe Date: Sat, 6 Jul 2024 12:59:24 +0530 Subject: [PATCH 3/3] Apply suggestions from code review --- README.md | 2 +- ballerina/Module.md | 2 +- ballerina/Package.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 40e8758..cf6c47a 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ Now, utilize the available connector operations. ```ballerina public function main() returns error? { - ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); + ConnectedAccountResponse[] connectedAccounts = check discord->/users/\@me/connections(); } ```` diff --git a/ballerina/Module.md b/ballerina/Module.md index edce9db..5a7f210 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -79,7 +79,7 @@ Now, utilize the available connector operations. ```ballerina public function main() returns error? { - ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); + ConnectedAccountResponse[] connectedAccounts = check discord->/users/\@me/connections(); } ```` diff --git a/ballerina/Package.md b/ballerina/Package.md index edce9db..5a7f210 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -79,7 +79,7 @@ Now, utilize the available connector operations. ```ballerina public function main() returns error? { - ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections(); + ConnectedAccountResponse[] connectedAccounts = check discord->/users/\@me/connections(); } ````