Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add module.md and update README with setup guide information #5

Merged
merged 29 commits into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
36c3329
Add Images for set up guide
HussainLatiff Jun 20, 2024
1816b66
Merge branch 'main' of https://github.com/HussainLatiff/module-baller…
HussainLatiff Jun 20, 2024
d090978
Add images for setup guide
HussainLatiff Jun 24, 2024
b883802
Add Setup guide info
HussainLatiff Jun 24, 2024
78f3f4f
Update Image for the final step in Set up guide
HussainLatiff Jun 25, 2024
a1e6d15
Update README.md with correct package name
HussainLatiff Jun 26, 2024
9ef169d
Add image for create account step in Set Up guide
HussainLatiff Jun 26, 2024
8bd9540
Add instructions to create new discord account in Set Up guide
HussainLatiff Jun 26, 2024
e30f1b3
Update the Set up guide with instructions on creating a new discord a…
HussainLatiff Jun 26, 2024
ecd8e97
Remove redundant Information in module.md
HussainLatiff Jun 26, 2024
b7b1fbb
Format Step 1 in the Set Up guide
HussainLatiff Jun 26, 2024
2311c06
Update the errors in heading and formatting
HussainLatiff Jun 26, 2024
2a69be9
Include Quick Start information in readme and module
HussainLatiff Jun 26, 2024
c63e67d
updated the instantiate a new conector step with better varaibles for…
HussainLatiff Jun 27, 2024
7d1f64a
Update the code in the QuickStart to be more descriptive
HussainLatiff Jun 28, 2024
b8d5951
Remove unrequired heading in QuickStart steps README.md
HussainLatiff Jun 28, 2024
6d2c284
Add full stops to the ballerina/Module.md sentences
HussainLatiff Jun 28, 2024
ea88ba2
Corrected wording for the initial links in ballerina/Module.md
HussainLatiff Jun 28, 2024
ea7349c
Update with corrected capitalization in the ballerina/Module.md
HussainLatiff Jun 28, 2024
14580e4
Correct capitalization in the word discord in ballerina/Module.md
HussainLatiff Jun 28, 2024
0a67a58
Update the second heading for the quick start with better capitaliza…
HussainLatiff Jun 28, 2024
64ed344
Corrected capitalization in the heading of Step 1 in QuickStart ball…
HussainLatiff Jun 28, 2024
0d16d7f
Update the code with better variable names in the code snippet baller…
HussainLatiff Jun 28, 2024
45fe99c
Add full stop at the end of step 3 ballerina/Module.md
HussainLatiff Jun 28, 2024
200ee64
Add better variable name and type for code snippets for the example b…
HussainLatiff Jun 28, 2024
39f3020
Updated Readme to mirror the changes made to module.md
HussainLatiff Jun 28, 2024
d1b91de
changed capitilization in
HussainLatiff Jul 1, 2024
847375d
Fixed all improper capitilization for the word "Discord"
HussainLatiff Jul 1, 2024
ebe5cdd
Add two final steps in module.md
HussainLatiff Jul 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ The Ballerina Discord connector offers APIs to connect and interact with the [Di

## Setup guide

Follow these steps to create a discord developer account.
Follow these steps to create a Discord developer account.

### Step 1: Login to Discord developer page

<img src="https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/discord-dev-page.png?raw=true">

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.
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.

<img src= "https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/create-acc.png?raw=true">

Expand All @@ -24,13 +24,13 @@ Complete the account creation process by including the relavant information in t

<img src="https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/make-new-app.png?raw=true">

Once in the discord developer portal is open, click on the `New Application` button as displayed above to start the process.
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

<img src="https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/create-app.png?raw=true">

1. Proceed by giving the discord Application a name and click on the terms of service.
1. Proceed by giving the Discord Application a name and click on the terms of service.

2. Finally complete the naming process by clicking on the `next` button.

Expand Down
26 changes: 5 additions & 21 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ The Ballerina Discord connector offers APIs to connect and interact with the [Di

## Setup guide

Follow these steps to create a discord developer account.
Follow these steps to create a Discord developer account.

### Step 1: Login to Discord developer page

<img src="https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/discord-dev-page.png?raw=true">

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.
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.

<img src= "https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/create-acc.png?raw=true">

Expand All @@ -24,13 +24,13 @@ Complete the account creation process by including the relavant information in t

<img src="https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/make-new-app.png?raw=true">

Once in the discord developer portal is open, click on the `New Application` button as displayed above to start the process.
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

<img src="https://github.com/HussainLatiff/module-ballerinax-discord/blob/main/docs/setup/resources/create-app.png?raw=true">

1. Proceed by giving the discord Application a name and click on the terms of service.
1. Proceed by giving the Discord Application a name and click on the terms of service.

2. Finally complete the naming process by clicking on the `next` button.

Expand Down Expand Up @@ -71,19 +71,3 @@ discord:Client discord = check new({
}
});
```


### Step 3: Invoke the connector operation
Now, utilize the available connector operations.

### Return linked third-party accounts of the user

```ballerina
ConnectedAccountResponse[] connectedAccounts = check cl->/users/\@me/connections();
````

### Step 4: Run the Ballerina application

```bash
bal run
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why have we removed this?

Loading