Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

added LinkedIn OAuth provider guide #406

Open
wants to merge 2 commits into
base: oauth-providers
Choose a base branch
from

Conversation

Dksie09
Copy link

@Dksie09 Dksie09 commented Aug 8, 2023

What does this PR do?

Provides a detailed guide for adding LinkedIn OAuth

Have you read the Contributing Guidelines on issues?

yes

Copy link
Contributor

@gewenyu99 gewenyu99 left a comment

Choose a reason for hiding this comment

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

Small comments. Good job!


## Creating a LinkedIn Developer app

To use LinkedIn OAuth with Appwrite, you need to create a LinkedIn Developer app. You can do this by following the [How to Implement OAuth](https://learn.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow?tabs=HTTPS1#how-to-implement-3-legged-oauth) guide from LinkedIn.
Copy link
Contributor

Choose a reason for hiding this comment

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

@Dksie09 As per DM, find a better post?

Copy link
Author

Choose a reason for hiding this comment

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

Steven confirmed it's 3 legged, so should we just keep it this way?


After you've created your LinkedIn OAuth app, you can head back to your Appwrite console to complete the form in the **Linkedin OAuth2 Settings** modal.

- Find the **Client ID** in the Auth tab of your LinkedIn developer app and provide this in the **App ID** field in the **Linkedin OAuth2 Settings** modal from the Appwrite console.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Find the **Client ID** in the Auth tab of your LinkedIn developer app and provide this in the **App ID** field in the **Linkedin OAuth2 Settings** modal from the Appwrite console.
- Find the **Client ID** in the Auth tab of your LinkedIn developer app. Provide this in the Appwrite console's **Linkedin OAuth2 Settings** modal, in the **App ID** field.

I would even split this up to be 2 lines for readability.

After you've created your LinkedIn OAuth app, you can head back to your Appwrite console to complete the form in the **Linkedin OAuth2 Settings** modal.

- Find the **Client ID** in the Auth tab of your LinkedIn developer app and provide this in the **App ID** field in the **Linkedin OAuth2 Settings** modal from the Appwrite console.
- Similarly, find the **Client secret** in the Auth tab of your LinkedIn developer app and provide this in the **App Secret** field in the **Linkedin OAuth2 Settings** modal from the Appwrite console.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto with comment above. Split this up into more lines/sentences for readability.

Try to write in a clear top down hierarchy: [site][modal][field] so it's easier to read.

- Find the **Client ID** in the Auth tab of your LinkedIn developer app and provide this in the **App ID** field in the **Linkedin OAuth2 Settings** modal from the Appwrite console.
- Similarly, find the **Client secret** in the Auth tab of your LinkedIn developer app and provide this in the **App Secret** field in the **Linkedin OAuth2 Settings** modal from the Appwrite console.

When adding a **Redirect URL** in OAuth 2.0 settings, provide the **URI** found in the **Linkedin OAuth2 Settings** modal from your Appwrite console and click on **Update**.
Copy link
Contributor

Choose a reason for hiding this comment

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

same as above comments.


client
.setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
.setProject("[PROJECT_ID]"); // Your project ID
Copy link
Contributor

Choose a reason for hiding this comment

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

For these examples, try to line up the comments.

client
  .setEndpoint("https://cloud.appwrite.io/v1")  // Your API Endpoint
  .setProject("[PROJECT_ID]");                  // Your project ID

Like this ☝️

@Dksie09 Dksie09 requested a review from gewenyu99 August 11, 2023 01:27
Copy link

@Haimantika Haimantika left a comment

Choose a reason for hiding this comment

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

The changes look good to me.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants