From f0868450c8bd251ba5ed2900e27d75097451068a Mon Sep 17 00:00:00 2001 From: Thisaru Guruge Date: Thu, 23 Jan 2025 11:32:15 +0530 Subject: [PATCH] Fix documentation issues --- README.md | 29 +++++++++++----------- ballerina/Module.md | 31 ++++++++++++------------ ballerina/Package.md | 31 ++++++++++++------------ issue_template.md | 18 -------------- pull_request_template.md | 52 ---------------------------------------- 5 files changed, 47 insertions(+), 114 deletions(-) delete mode 100644 issue_template.md delete mode 100644 pull_request_template.md diff --git a/README.md b/README.md index e1968b1..0d742a3 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Overview -[HubSpot](https://www.hubspot.com) is an AI-powered customer relationship management (CRM) platform. +[HubSpot](https://www.hubspot.com) is an AI-powered customer relationship management (CRM) platform. The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact with the [Taxes](https://developers.hubspot.com/docs/guides/api/crm/commerce/taxes) endpoints, specifically based on the [HubSpot REST API](https://developers.hubspot.com/docs/reference/api) @@ -17,6 +17,7 @@ The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact wi You need a [HubSpot developer account](https://developers.hubspot.com/get-started) with an [app](https://developers.hubspot.com/docs/guides/apps/public-apps/overview) to use HubSpot connectors. ### Step 1: Create HubSpot Developer Project + 1. [Login](https://app.hubspot.com/login) to HubSpot developer account. 2. Create a public app by clicking on Create app. @@ -24,29 +25,30 @@ You need a [HubSpot developer account](https://developers.hubspot.com/get-starte ![Create public app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/build_public_app.png) 3. Click on "Create app". -![Create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/create_app.png) + ![Create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/create_app.png) 4. Under "App Info" - Enter "Public app name". - Update "App logo" (optional). - - Update "Description" (optional). + - Update "Description" (optional). ![Enter app details](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/enter_app_details.png) -- Then move to the "Auth" tab. + Then move to the "Auth" tab. 5. Setup the "Redirect URLs" with respective links. ![Auth page](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/auth_page.png) -Finally "Create app". +6. Finally click on "Create app". + +### Step 2: Get `Client ID` and `Client secret` -### Step 2: Get `Client ID` and `Client secret`. Navigate to the "Auth" tab. ![Client Id, secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/client_id_secret.png) -### Step 3: Get `access token` and `refresh token`. +### Step 3: Get `access token` and `refresh token` 1. Set scopes under "Auth" tab for your app based on the [API requirements](https://developers.hubspot.com/docs/reference/api). @@ -58,7 +60,8 @@ Navigate to the "Auth" tab. - `oauth` 2. In the "Auth" tab under "Sample install URL (OAuth)" section "Copy full URL". - >**Note:** The above copied URL is in the following format. + > **Note:** The above copied URL is in the following format. + ``` https://app.hubspot.com/oauth/authorize?client_id=&redirect_uri=&scope= ``` @@ -73,7 +76,7 @@ Navigate to the "Auth" tab. 5. Send a http request to the HubSpot. - * Linux/macOS + - Linux/macOS ```bash curl --request POST \ @@ -82,7 +85,7 @@ Navigate to the "Auth" tab. --data 'grant_type=authorization_code&code=&redirect_uri=&client_id=&client_secret=' ``` - * Windows + - Windows ```bash curl --request POST ^ @@ -130,7 +133,7 @@ import ballerinax/hubspot.crm.commerce.taxes; clientId, clientSecret, refreshToken, - credentialBearer: oauth2:POST_BODY_BEARER + credentialBearer: oauth2:POST_BODY_BEARER } }; final taxes:Client hubSpotClient = check new (config); @@ -138,7 +141,7 @@ import ballerinax/hubspot.crm.commerce.taxes; ### Step 3: Invoke the connector operation -Now, utilize the available connector operations. A sample usecase is shown below. +Now, utilize the available connector operations. A sample use case is shown below. #### Create a New Tax @@ -153,9 +156,7 @@ Now, utilize the available connector operations. A sample usecase is shown below "hs_type": "PERCENT", "hs_value": "6" } - taxes:SimplePublicObject response = check hubspotClientTax->/.post(payload); - }; ``` diff --git a/ballerina/Module.md b/ballerina/Module.md index 3c1b842..f2f8d1e 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -1,6 +1,6 @@ ## Overview -[HubSpot](https://www.hubspot.com) is an AI-powered customer relationship management (CRM) platform. +[HubSpot](https://www.hubspot.com) is an AI-powered customer relationship management (CRM) platform. The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact with the [Taxes](https://developers.hubspot.com/docs/guides/api/crm/commerce/taxes) endpoints, specifically based on the [HubSpot REST API](https://developers.hubspot.com/docs/reference/api) @@ -9,6 +9,7 @@ The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact wi You need a [HubSpot developer account](https://developers.hubspot.com/get-started) with an [app](https://developers.hubspot.com/docs/guides/apps/public-apps/overview) to use HubSpot connectors. ### Step 1: Create HubSpot Developer Project + 1. [Login](https://app.hubspot.com/login) to HubSpot developer account. 2. Create a public app by clicking on Create app. @@ -16,29 +17,30 @@ You need a [HubSpot developer account](https://developers.hubspot.com/get-starte ![Create public app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/build_public_app.png) 3. Click on "Create app". -![Create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/create_app.png) + ![Create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/create_app.png) 4. Under "App Info" - Enter "Public app name". - Update "App logo" (optional). - - Update "Description" (optional). + - Update "Description" (optional). ![Enter app details](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/enter_app_details.png) -- Then move to the "Auth" tab. + Then move to the "Auth" tab. 5. Setup the "Redirect URLs" with respective links. ![Auth page](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/auth_page.png) -Finally "Create app". +6. Finally click on "Create app". + +### Step 2: Get `Client ID` and `Client secret` -### Step 2: Get `Client ID` and `Client secret`. Navigate to the "Auth" tab. ![Client Id, secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/client_id_secret.png) -### Step 3: Get `access token` and `refresh token`. +### Step 3: Get `access token` and `refresh token` 1. Set scopes under "Auth" tab for your app based on the [API requirements](https://developers.hubspot.com/docs/reference/api). @@ -50,7 +52,8 @@ Navigate to the "Auth" tab. - `oauth` 2. In the "Auth" tab under "Sample install URL (OAuth)" section "Copy full URL". - >**Note:** The above copied URL is in the following format. + > **Note:** The above copied URL is in the following format. + ``` https://app.hubspot.com/oauth/authorize?client_id=&redirect_uri=&scope= ``` @@ -65,7 +68,7 @@ Navigate to the "Auth" tab. 5. Send a http request to the HubSpot. - * Linux/macOS + - Linux/macOS ```bash curl --request POST \ @@ -74,7 +77,7 @@ Navigate to the "Auth" tab. --data 'grant_type=authorization_code&code=&redirect_uri=&client_id=&client_secret=' ``` - * Windows + - Windows ```bash curl --request POST ^ @@ -122,7 +125,7 @@ import ballerinax/hubspot.crm.commerce.taxes; clientId, clientSecret, refreshToken, - credentialBearer: oauth2:POST_BODY_BEARER + credentialBearer: oauth2:POST_BODY_BEARER } }; final taxes:Client hubSpotClient = check new (config); @@ -130,7 +133,7 @@ import ballerinax/hubspot.crm.commerce.taxes; ### Step 3: Invoke the connector operation -Now, utilize the available connector operations. A sample usecase is shown below. +Now, utilize the available connector operations. A sample use case is shown below. #### Create a New Tax @@ -145,9 +148,7 @@ Now, utilize the available connector operations. A sample usecase is shown below "hs_type": "PERCENT", "hs_value": "6" } - taxes:SimplePublicObject response = check hubspotClientTax->/.post(payload); - }; ``` @@ -156,4 +157,4 @@ Now, utilize the available connector operations. A sample usecase is shown below The `HubSpot CRM Commerce Taxes` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples), covering the following use cases: 1. [Manage Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/manage-taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to create a tax and manage it through the sales pipeline. -2. [Search Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/search_taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to search for taxes using properties and create a batch of taxes \ No newline at end of file +2. [Search Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/search_taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to search for taxes using properties and create a batch of taxes diff --git a/ballerina/Package.md b/ballerina/Package.md index 3c1b842..f2f8d1e 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -1,6 +1,6 @@ ## Overview -[HubSpot](https://www.hubspot.com) is an AI-powered customer relationship management (CRM) platform. +[HubSpot](https://www.hubspot.com) is an AI-powered customer relationship management (CRM) platform. The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact with the [Taxes](https://developers.hubspot.com/docs/guides/api/crm/commerce/taxes) endpoints, specifically based on the [HubSpot REST API](https://developers.hubspot.com/docs/reference/api) @@ -9,6 +9,7 @@ The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact wi You need a [HubSpot developer account](https://developers.hubspot.com/get-started) with an [app](https://developers.hubspot.com/docs/guides/apps/public-apps/overview) to use HubSpot connectors. ### Step 1: Create HubSpot Developer Project + 1. [Login](https://app.hubspot.com/login) to HubSpot developer account. 2. Create a public app by clicking on Create app. @@ -16,29 +17,30 @@ You need a [HubSpot developer account](https://developers.hubspot.com/get-starte ![Create public app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/build_public_app.png) 3. Click on "Create app". -![Create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/create_app.png) + ![Create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/create_app.png) 4. Under "App Info" - Enter "Public app name". - Update "App logo" (optional). - - Update "Description" (optional). + - Update "Description" (optional). ![Enter app details](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/enter_app_details.png) -- Then move to the "Auth" tab. + Then move to the "Auth" tab. 5. Setup the "Redirect URLs" with respective links. ![Auth page](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/auth_page.png) -Finally "Create app". +6. Finally click on "Create app". + +### Step 2: Get `Client ID` and `Client secret` -### Step 2: Get `Client ID` and `Client secret`. Navigate to the "Auth" tab. ![Client Id, secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/main/docs/setup/resources/client_id_secret.png) -### Step 3: Get `access token` and `refresh token`. +### Step 3: Get `access token` and `refresh token` 1. Set scopes under "Auth" tab for your app based on the [API requirements](https://developers.hubspot.com/docs/reference/api). @@ -50,7 +52,8 @@ Navigate to the "Auth" tab. - `oauth` 2. In the "Auth" tab under "Sample install URL (OAuth)" section "Copy full URL". - >**Note:** The above copied URL is in the following format. + > **Note:** The above copied URL is in the following format. + ``` https://app.hubspot.com/oauth/authorize?client_id=&redirect_uri=&scope= ``` @@ -65,7 +68,7 @@ Navigate to the "Auth" tab. 5. Send a http request to the HubSpot. - * Linux/macOS + - Linux/macOS ```bash curl --request POST \ @@ -74,7 +77,7 @@ Navigate to the "Auth" tab. --data 'grant_type=authorization_code&code=&redirect_uri=&client_id=&client_secret=' ``` - * Windows + - Windows ```bash curl --request POST ^ @@ -122,7 +125,7 @@ import ballerinax/hubspot.crm.commerce.taxes; clientId, clientSecret, refreshToken, - credentialBearer: oauth2:POST_BODY_BEARER + credentialBearer: oauth2:POST_BODY_BEARER } }; final taxes:Client hubSpotClient = check new (config); @@ -130,7 +133,7 @@ import ballerinax/hubspot.crm.commerce.taxes; ### Step 3: Invoke the connector operation -Now, utilize the available connector operations. A sample usecase is shown below. +Now, utilize the available connector operations. A sample use case is shown below. #### Create a New Tax @@ -145,9 +148,7 @@ Now, utilize the available connector operations. A sample usecase is shown below "hs_type": "PERCENT", "hs_value": "6" } - taxes:SimplePublicObject response = check hubspotClientTax->/.post(payload); - }; ``` @@ -156,4 +157,4 @@ Now, utilize the available connector operations. A sample usecase is shown below The `HubSpot CRM Commerce Taxes` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples), covering the following use cases: 1. [Manage Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/manage-taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to create a tax and manage it through the sales pipeline. -2. [Search Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/search_taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to search for taxes using properties and create a batch of taxes \ No newline at end of file +2. [Search Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/search_taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to search for taxes using properties and create a batch of taxes diff --git a/issue_template.md b/issue_template.md deleted file mode 100644 index 52a7563..0000000 --- a/issue_template.md +++ /dev/null @@ -1,18 +0,0 @@ -**Description:** - - -**Suggested Labels:** - - -**Suggested Assignees:** - - -**Affected Product Version:** - -**OS, DB, other environment details and versions:** - -**Steps to reproduce:** - - -**Related Issues:** - diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 45221b5..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,52 +0,0 @@ -## Purpose -> Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc. - -## Goals -> Describe the solutions that this feature/fix will introduce to resolve the problems described above - -## Approach -> Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here. - -## User stories -> Summary of user stories addressed by this change> - -## Release note -> Brief description of the new feature or bug fix as it will appear in the release notes - -## Documentation -> Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact - -## Training -> Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable - -## Certification -> Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why. - -## Marketing -> Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable - -## Automation tests - - Unit tests - > Code coverage information - - Integration tests - > Details about the test cases and coverage - -## Security checks - - Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no - - Ran FindSecurityBugs plugin and verified report? yes/no - - Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no - -## Samples -> Provide high-level details about the samples related to this feature - -## Related PRs -> List any other related PRs - -## Migrations (if applicable) -> Describe migration steps and platforms on which migration has been tested - -## Test environment -> List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested - -## Learning -> Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.