Update Google Calendar's scenario 2 instructions #37549
Conversation
The Google OAuth flow seems to have changed. Updated the *Scenario 2: You do not have credentials set up yet* section.
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes update the instructions in the documentation for generating a Google client ID and client secret. The revision reorganizes the step-by-step process, adjusts and renumbers the steps, and emphasizes the configuration of the project settings. Instructions for navigating the API enabling process, configuring the OAuth consent screen, and downloading the OAuth client have been clarified and consolidated. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Console as Google Developers Console
User->>Console: Open Developers Console and select project
User->>Console: Access project configuration (app info, support email, audience)
User->>Console: Enable API and navigate to credentials section
User->>Console: Initiate OAuth consent screen setup (click Next, review policy)
User->>Console: Download OAuth client to retrieve client ID and secret
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_includes/integrations/google_client_secret.md (1)
40-40: Punctuation and Grammar EnhancementsThere are a few minor punctuation issues that could improve readability:
- Line 40: Insert a comma after "Otherwise" to read:
> Otherwise, your credentials will expire every 7 days.- Line 47: Consider adding a comma after "Find the client you just created" for better clarity:
1. Find the client you just created, under the Actions column choose **Download OAuth client** ...- Line 50: Insert a comma after "In most cases" so that it reads:
- Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases, your new credentials will be active within a few minutes. However, Google states that activation may take up to five hours in some circumstances.These small fixes will help polish the text according to the language guidelines.
Also applies to: 47-47, 50-50
🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...sting**, select Publish app. > Otherwise your credentials will expire every 7 da...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/integrations/google_client_secret.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/integrations/google_client_secret.md
[uncategorized] ~40-~40: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...sting**, select Publish app. > Otherwise your credentials will expire every 7 da...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...ent you just created. Under the Actions column choose Download OAuth client (downl...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~50-~50: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...atulations! You are now the keeper of a client secret. Guard it in your treasure box. ...
(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
[formatting] ~50-~50: Insert a comma after ‘cases’: “In most cases,”?
Context: ... secret. Guard it in your treasure box. In most cases your new credentials will be active wit...
(IN_MOST_CASES_COMMA)
🪛 GitHub Actions: home-assistant.io Test
source/_includes/integrations/google_client_secret.md
[warning] 25-25: Unexpected ordered list item value 1, expected 2 ordered-list-marker-value remark-lint
[warning] 26-26: Unexpected ordered list item value 1, expected 3 ordered-list-marker-value remark-lint
[warning] 27-27: Unexpected ordered list item value 1, expected 4 ordered-list-marker-value remark-lint
[warning] 28-28: Unexpected ordered list item value 1, expected 5 ordered-list-marker-value remark-lint
[warning] 29-29: Unexpected ordered list item value 1, expected 6 ordered-list-marker-value remark-lint
[warning] 38-38: Unexpected ordered list item value 1, expected 7 ordered-list-marker-value remark-lint
[warning] 41-41: Unexpected ordered list item value 1, expected 8 ordered-list-marker-value remark-lint
[warning] 47-47: Unexpected ordered list item value 1, expected 9 ordered-list-marker-value remark-lint
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_includes/integrations/google_client_secret.md (1)
8-55: Overall Clarity and Improved Instruction FlowThe restructuring of the instructions—especially for the OAuth consent screen configuration and subsequent credential creation—is clear and well organized. The added guidance for each step (e.g., selecting options and clicking Next) should greatly help users who are setting up their credentials for the first time.
Great job on enhancing the clarity, accessibility, and detail of the documentation!
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... client ID and client secret on [Google Developers Console]({{ google_dev_console_link }})...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~40-~40: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...sting**, select Publish app. > Otherwise your credentials will expire every 7 da...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...ent you just created. Under the Actions column choose Download OAuth client (downl...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~50-~50: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...atulations! You are now the keeper of a client secret. Guard it in your treasure box. ...(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
[formatting] ~50-~50: Insert a comma after ‘cases’: “In most cases,”?
Context: ... secret. Guard it in your treasure box. In most cases your new credentials will be active wit...(IN_MOST_CASES_COMMA)
🪛 markdownlint-cli2 (0.17.2)
14-14: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
14-14: Link fragments should be valid
null(MD051, link-fragments)
15-15: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above(MD022, blanks-around-headings)
🪛 GitHub Actions: home-assistant.io Test
[warning] 25-25: Unexpected ordered list item value
1, expected2ordered-list-marker-value remark-lint
[warning] 26-26: Unexpected ordered list item value
1, expected3ordered-list-marker-value remark-lint
[warning] 27-27: Unexpected ordered list item value
1, expected4ordered-list-marker-value remark-lint
[warning] 28-28: Unexpected ordered list item value
1, expected5ordered-list-marker-value remark-lint
[warning] 29-29: Unexpected ordered list item value
1, expected6ordered-list-marker-value remark-lint
[warning] 38-38: Unexpected ordered list item value
1, expected7ordered-list-marker-value remark-lint
[warning] 41-41: Unexpected ordered list item value
1, expected8ordered-list-marker-value remark-lint
[warning] 47-47: Unexpected ordered list item value
1, expected9ordered-list-marker-value remark-lint
| 1. Select **Create project**, enter a project name and select **Create**. | ||
| 1. **Enable** the {{ api }}. | ||
| 1. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials). | ||
| 1. In the left sidebar, select **OAuth consent screen**. | ||
| 1. It will take you to the Overview page and ask for **Project Configuration**: | ||
| - Complete the App Information: | ||
| - Set the **App name** (the name of the application asking for consent) to anything you want, for example, *Home Assistant*. | ||
| - For a **Support email**, choose your email address from the dropdown menu. | ||
| - Click **Next**. | ||
| - For Audience, select **External** then click **Next**. | ||
| - Under Contact Information, enter your email address (the same as above is fine). Click **Next**. | ||
| - Read the policy and check the box if you agree. Click **Continue**. | ||
| - Click **Create**. | ||
| 1. In the left sidebar, select **Audience**: | ||
| - Under **Publishing status > Testing**, select **Publish app**. | ||
| > Otherwise your credentials will expire every 7 days. | ||
| 1. In the left sidebar, select **Clients**: | ||
| - Click **+ Create Client**. | ||
| - For Application type, choose **Web Application** and give this client ID a name (like "Home Assistant Client"). | ||
| - Add `https://my.home-assistant.io/redirect/oauth` to **Authorized redirect URIs** then select **Create**. | ||
| > **Note**: This is not a placeholder. It is the URI that must be used. | ||
| - Click **Create**. | ||
| 1. Find the client you just created. Under the Actions column choose **Download OAuth client** (download icon), which will show you the **Client ID** and **Client Secret**. | ||
| - Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly. | ||
| - Once you have noted these strings, select **Close**. | ||
| - Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases your new credentials will be active within a few minutes. However, Google states that activation may take up to five hours in some circumstances. | ||
| > If you need to find these credentials again at any point, then navigate to **APIs & Services** > **Credentials**, and you will see **Home Assistant Credentials** (or whatever you named them in the previous step) under **OAuth 2.0 Client IDs**. | ||
| > | ||
| > To view the **Client ID** and **Client Secret**, click the **Download OAuth client** (download icon) under the Actions column. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Sequential Ordered List Numbering
The updated instructions now use "1." for every step in this section, which is causing pipeline linter warnings (e.g., "expected 2, 3, etc."). To improve both readability and compliance with the style guidelines, please update the ordered list numbering so that they are sequential (e.g., 1., 2., 3., …).
For example, you might change:
-1. Select **Create project**, enter a project name and select **Create**.
-1. **Enable** the {{ api }}.
-1. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials).
+1. Select **Create project**, enter a project name and select **Create**.
+2. **Enable** the {{ api }}.
+3. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials).This adjustment will resolve the linter warnings and enhance the clarity of the step-by-step instructions.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Select **Create project**, enter a project name and select **Create**. | |
| 1. **Enable** the {{ api }}. | |
| 1. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials). | |
| 1. In the left sidebar, select **OAuth consent screen**. | |
| 1. It will take you to the Overview page and ask for **Project Configuration**: | |
| - Complete the App Information: | |
| - Set the **App name** (the name of the application asking for consent) to anything you want, for example, *Home Assistant*. | |
| - For a **Support email**, choose your email address from the dropdown menu. | |
| - Click **Next**. | |
| - For Audience, select **External** then click **Next**. | |
| - Under Contact Information, enter your email address (the same as above is fine). Click **Next**. | |
| - Read the policy and check the box if you agree. Click **Continue**. | |
| - Click **Create**. | |
| 1. In the left sidebar, select **Audience**: | |
| - Under **Publishing status > Testing**, select **Publish app**. | |
| > Otherwise your credentials will expire every 7 days. | |
| 1. In the left sidebar, select **Clients**: | |
| - Click **+ Create Client**. | |
| - For Application type, choose **Web Application** and give this client ID a name (like "Home Assistant Client"). | |
| - Add `https://my.home-assistant.io/redirect/oauth` to **Authorized redirect URIs** then select **Create**. | |
| > **Note**: This is not a placeholder. It is the URI that must be used. | |
| - Click **Create**. | |
| 1. Find the client you just created. Under the Actions column choose **Download OAuth client** (download icon), which will show you the **Client ID** and **Client Secret**. | |
| - Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly. | |
| - Once you have noted these strings, select **Close**. | |
| - Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases your new credentials will be active within a few minutes. However, Google states that activation may take up to five hours in some circumstances. | |
| > If you need to find these credentials again at any point, then navigate to **APIs & Services** > **Credentials**, and you will see **Home Assistant Credentials** (or whatever you named them in the previous step) under **OAuth 2.0 Client IDs**. | |
| > | |
| > To view the **Client ID** and **Client Secret**, click the **Download OAuth client** (download icon) under the Actions column. | |
| 1. Select **Create project**, enter a project name and select **Create**. | |
| 2. **Enable** the {{ api }}. | |
| 3. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials). | |
| 1. In the left sidebar, select **OAuth consent screen**. | |
| 1. It will take you to the Overview page and ask for **Project Configuration**: | |
| - Complete the App Information: | |
| - Set the **App name** (the name of the application asking for consent) to anything you want, for example, *Home Assistant*. | |
| - For a **Support email**, choose your email address from the dropdown menu. | |
| - Click **Next**. | |
| - For Audience, select **External** then click **Next**. | |
| - Under Contact Information, enter your email address (the same as above is fine). Click **Next**. | |
| - Read the policy and check the box if you agree. Click **Continue**. | |
| - Click **Create**. | |
| 1. In the left sidebar, select **Audience**: | |
| - Under **Publishing status > Testing**, select **Publish app**. | |
| > Otherwise your credentials will expire every 7 days. | |
| 1. In the left sidebar, select **Clients**: | |
| - Click **+ Create Client**. | |
| - For Application type, choose **Web Application** and give this client ID a name (like "Home Assistant Client"). | |
| - Add `https://my.home-assistant.io/redirect/oauth` to **Authorized redirect URIs** then select **Create**. | |
| > **Note**: This is not a placeholder. It is the URI that must be used. | |
| - Click **Create**. | |
| 1. Find the client you just created. Under the Actions column choose **Download OAuth client** (download icon), which will show you the **Client ID** and **Client Secret**. | |
| - Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly. | |
| - Once you have noted these strings, select **Close**. | |
| - Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases your new credentials will be active within a few minutes. However, Google states that activation may take up to five hours in some circumstances. | |
| > If you need to find these credentials again at any point, then navigate to **APIs & Services** > **Credentials**, and you will see **Home Assistant Credentials** (or whatever you named them in the previous step) under **OAuth 2.0 Client IDs**. | |
| > | |
| > To view the **Client ID** and **Client Secret**, click the **Download OAuth client** (download icon) under the Actions column. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...sting**, select Publish app. > Otherwise your credentials will expire every 7 da...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...ent you just created. Under the Actions column choose Download OAuth client (downl...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~50-~50: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...atulations! You are now the keeper of a client secret. Guard it in your treasure box. ...
(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
[formatting] ~50-~50: Insert a comma after ‘cases’: “In most cases,”?
Context: ... secret. Guard it in your treasure box. In most cases your new credentials will be active wit...
(IN_MOST_CASES_COMMA)
🪛 GitHub Actions: home-assistant.io Test
[warning] 25-25: Unexpected ordered list item value 1, expected 2 ordered-list-marker-value remark-lint
[warning] 26-26: Unexpected ordered list item value 1, expected 3 ordered-list-marker-value remark-lint
[warning] 27-27: Unexpected ordered list item value 1, expected 4 ordered-list-marker-value remark-lint
[warning] 28-28: Unexpected ordered list item value 1, expected 5 ordered-list-marker-value remark-lint
[warning] 29-29: Unexpected ordered list item value 1, expected 6 ordered-list-marker-value remark-lint
[warning] 38-38: Unexpected ordered list item value 1, expected 7 ordered-list-marker-value remark-lint
[warning] 41-41: Unexpected ordered list item value 1, expected 8 ordered-list-marker-value remark-lint
[warning] 47-47: Unexpected ordered list item value 1, expected 9 ordered-list-marker-value remark-lint
| - To view both the **Client ID** and **Client secret**, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page. | ||
| 16. Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases your new credentials will be active within a few moments. However, Google states that activation may take up to five hours in some circumstances. | ||
|
|
||
| 1. Select **Create project**, enter a project name and select **Create**. |
There was a problem hiding this comment.
please fix the numbering, as indicated by coderabbitai
|
I've marked this PR as draft, as changes are requested that need to be processed. Thanks! 👍 ../Frenck |
fix numbering and punctuation based on coderabbit's feedback
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_includes/integrations/google_client_secret.md (2)
38-40: Audience Step – Clarity of InstructionThe instructions for selecting Audience (step 7) are concise and clear. If it would help users further, consider adding a brief note about what “Publish app” entails (for example, that it initiates the testing phase or finalizes the selection).
47-53: Credential Retrieval Step – Phrasing and Punctuation SuggestionThe final step (step 9) instructs users on how to download their OAuth client, and the additional note on client secret safety is valuable. However, the sentence on line 50:
"Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases, your new credentials will be active within a few minutes. However, Google states that activation may take up to five hours in some circumstances."
triggers a LanguageTool suggestion regarding a possible possessive apostrophe (or punctuation clarification). Consider revising it to improve clarity. For example, you might change it to:
- Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases, your new credentials will be active within a few minutes. However, Google states that activation may take up to five hours in some circumstances. + Congratulations! You are now the keeper of your client secret—guard it in your treasure box. In most cases, your new credentials will be active within a few minutes; however, Google states that activation may take up to five hours in some circumstances.This small tweak may help clarify the intended meaning and satisfy the static analysis hint.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~50-~50: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...atulations! You are now the keeper of a client secret. Guard it in your treasure box. ...(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/integrations/google_client_secret.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/integrations/google_client_secret.md
[uncategorized] ~50-~50: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...atulations! You are now the keeper of a client secret. Guard it in your treasure box. ...
(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
🔇 Additional comments (3)
source/_includes/integrations/google_client_secret.md (3)
24-28: Ordered List Numbering – Verify Sequential NumbersAlthough the list appears sequential (steps “1.”, “2.”, etc.), previous reviewer comments and pipeline warnings indicate that markdown auto-numbering issues can occur if each item is manually numbered. Please double-check that the rendered list in this details block indeed shows the intended sequential numbers and isn’t inadvertently resetting to “1.” for every item.
29-37: Project Configuration Step – Formatting and Clarity CheckThe “Project Configuration” step (step 6) is detailed with nested substeps that explain what to fill in (App Information, Support email, Audience, Contact Information, agreement, and creation). The instructions are clear and well-structured. Please verify that the nested bullet formatting renders consistently across various markdown processors.
41-46: Client Creation Step – Confirming DetailsThe step explaining how to create a new client (step 8) is well articulated. The inclusion of details like selecting Web Application, naming the client, and adding the authorized redirect URI is very useful. Please make sure that the URI
https://my.home-assistant.io/redirect/oauthis correct for all supported Home Assistant deployments.
Proposed change
Update instructions for Google Calendar under the "Scenario 2: You do not have credentials set up yet " section.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit