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 YouTube API enabling steps in readme.md #117

Merged
merged 8 commits into from
Mar 10, 2021

Conversation

s4-2
Copy link
Contributor

@s4-2 s4-2 commented Mar 3, 2021

Documentation

Add instruction in Readme.md includes step for enabling YT API.

Fixes #90

Type of Change:

Delete irrelevant options.

  • Documentation

Code/Quality Assurance Only

  • This change requires a documentation update (software upgrade on readme file)

How Has This Been Tested?

Describe the tests you ran to verify your changes. Provide instructions or GIFs so we can reproduce. List any relevant details for your test.

Checklist:

Delete irrelevant options.

  • My PR follows the style guidelines of this project
  • I have performed a self-review of my own code or materials

Code/Quality Assurance Only

  • My changes generate no new warnings

@s4-2
Copy link
Contributor Author

s4-2 commented Mar 3, 2021

@Rahulm2310 and @keshakaneria please check is this the right way to create a PR.
Thank you for your help.

@keshakaneria
Copy link
Member

@Rahulm2310 and @keshakaneria please check is this the right way to create a PR.
Thank you for your help.

You can have a look at a sample template for description for PR here. You need to checkmark the checkboxes which are completed.

@s4-2
Copy link
Contributor Author

s4-2 commented Mar 4, 2021 via email

@Rahulm2310
Copy link
Contributor

@s4-2 You can remove the irrelevant (unchecked) options from the PR description

README.md Outdated

**Steps**

- You need a [Google Account](https://www.google.com/accounts/NewAccount) to access the Google API Console, request an API key, and register your application.
Copy link
Contributor

Choose a reason for hiding this comment

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

@s4-2 As these steps follow a certain order, this list should be a numbered list instead of bullet points.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay

README.md Outdated
- Select a [client library](https://developers.google.com/youtube/v3/libraries) to simplify your API implementation.
- Familiarize yourself with the core concepts of the JSON (JavaScript Object Notation) data format. JSON is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see [json.org](http://json.org/).


Copy link
Contributor

Choose a reason for hiding this comment

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

Also, no need for these newlines.

Copy link
Contributor

Choose a reason for hiding this comment

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

You can put dots after numbers to get an enumerated list.

README.md Outdated
- Visit the [Enabled APIs page](https://console.developers.google.com/apis/enabled). In the list of APIs, make sure the status is ON for the YouTube Data API v3
- If your application will use any API methods that require user authorization, read the [authentication](https://developers.google.com/youtube/v3/guides/authentication) guide to learn how to implement OAuth 2.0 authorization.
- Select a [client library](https://developers.google.com/youtube/v3/libraries) to simplify your API implementation.
- Familiarize yourself with the core concepts of the JSON (JavaScript Object Notation) data format. JSON is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see [json.org](http://json.org/).
Copy link
Contributor

@Rahulm2310 Rahulm2310 Mar 9, 2021

Choose a reason for hiding this comment

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

I think the last three steps are not related to the youtube api enabling process and can be removed. We just need steps for enabling youtube api in google dev console.

@s4-2
Copy link
Contributor Author

s4-2 commented Mar 9, 2021

@Rahulm2310 Is this relevant now?

README.md Outdated
1 You need a [Google Account](https://www.google.com/accounts/NewAccount) to access the Google API Console, request an API key, and register your application.

2 Create a project in the [Google Developers Console](https://console.developers.google.com/) and [obtain authorization credentials](https://developers.google.com/youtube/registering_an_application) so your application can submit API requests.

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

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@annabauza annabauza merged commit 776aa8c into anitab-org:master Mar 10, 2021
@welcome
Copy link

welcome bot commented Mar 10, 2021

Congrats on merging your first pull request! 🎉🎉🎉 We here at AnitaB.org are proud of you!

@s4-2
Copy link
Contributor Author

s4-2 commented Mar 10, 2021

Sorry for late response, Thank you @annabauza :)

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

Successfully merging this pull request may close these issues.

docs: Update documentation with the details about enabling YT API
5 participants