n8n-io / n8n-docs

Documentation for n8n, a fair-code licensed automation tool with a free community edition and powerful enterprise options. Build AI functionality into your workflows.
https://docs.n8n.io
Other
156 stars 296 forks source link

DOC-968: Google credentials tweaks #2284

Closed freakwriter closed 1 month ago

freakwriter commented 1 month ago

Some wording updates to better align with current template and try to make clearer when you'd want to use which auth method.

This is already highly-detailed.

netlify[bot] commented 1 month ago

Deploy Preview for n8n-docs ready!

Name Link
Latest commit 60d2d87e9bcc032f251220a46c33c14fa473e79e
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/66abad4a4430fa00088a4603
Deploy Preview https://deploy-preview-2284--n8n-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions[bot] commented 1 month ago

Overall readability score: 42.25 (🟢 +0.03)

File Readability
create-google-cloud-project.md 60.4 (-)
enable-apis.md 59.29 (🔴 -0.22)
index.md 42.72 (🟢 +21.2)
oauth-generic.md 27.18 (🟢 +2.58)
oauth-single-service.md 48.17 (🔴 -8.39)
service-account.md 65.53 (🟢 +0.01)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [create-google-cloud-project.md](https://github.com/n8n-io/n8n-docs/blob/60d2d87e9bcc032f251220a46c33c14fa473e79e/_snippets/integrations/builtin/credentials/google/create-google-cloud-project.md "_snippets/integrations/builtin/credentials/google/create-google-cloud-project.md") | 60.4 | 48.81 | 9.03 | 11.8 | 12.52 | 7.49   | - | - | - | - | - | - [enable-apis.md](https://github.com/n8n-io/n8n-docs/blob/60d2d87e9bcc032f251220a46c33c14fa473e79e/_snippets/integrations/builtin/credentials/google/enable-apis.md "_snippets/integrations/builtin/credentials/google/enable-apis.md") | 59.29 | 43.8 | 7.06 | 12.7 | 13.73 | 7.69   | 🔴 -0.22 | 🔴 -4.7 | 🟢 +2.17 | 🔴 -0.9 | 🔴 -1.91 | 🟢 +0.26 [index.md](https://github.com/n8n-io/n8n-docs/blob/60d2d87e9bcc032f251220a46c33c14fa473e79e/docs/integrations/builtin/credentials/google/index.md "docs/integrations/builtin/credentials/google/index.md") | 42.72 | 27.59 | 8.89 | 15.5 | 17.72 | 8.02   | 🟢 +21.2 | 🟢 +26.26 | 🟢 +3.12 | 🟢 +6.5 | 🟢 +1.28 | 🟢 +0.08 [oauth-generic.md](https://github.com/n8n-io/n8n-docs/blob/60d2d87e9bcc032f251220a46c33c14fa473e79e/docs/integrations/builtin/credentials/google/oauth-generic.md "docs/integrations/builtin/credentials/google/oauth-generic.md") | 27.18 | 0 | 9.31 | 22 | 19 | 7.71   | 🟢 +2.58 | 🟢 +0 | 🟢 +0.49 | 🟢 +0 | 🟢 +0 | 🟢 +0.54 [oauth-single-service.md](https://github.com/n8n-io/n8n-docs/blob/60d2d87e9bcc032f251220a46c33c14fa473e79e/docs/integrations/builtin/credentials/google/oauth-single-service.md "docs/integrations/builtin/credentials/google/oauth-single-service.md") | 48.17 | 27.49 | 8.1 | 14.8 | 16.62 | 7.54   | 🔴 -8.39 | 🔴 -16.51 | 🔴 -0.52 | 🔴 -1 | 🔴 -1.74 | 🔴 -0.27 [service-account.md](https://github.com/n8n-io/n8n-docs/blob/60d2d87e9bcc032f251220a46c33c14fa473e79e/docs/integrations/builtin/credentials/google/service-account.md "docs/integrations/builtin/credentials/google/service-account.md") | 65.53 | 52.26 | 6.81 | 11.8 | 13.49 | 6.83   | 🟢 +0.01 | 🟢 +0.41 | 🟢 +0.46 | 🔴 -0.4 | 🔴 -0.46 | 🟢 +0.12 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 42.25 | 34.16 | 11.79 | 15.03 | 14.46 | 8.6   | 🟢 +0.03 | 🟢 +0.02 | 🟢 +0.01 | 🟢 +0.01 | 🟢 +0 | 🟢 +0
View metric targets Metric | Range | Ideal score --- | --- | --- Flesch Reading Ease | 100 (very easy read) to 0 (extremely difficult read) | 60 Gunning Fog | 6 (very easy read) to 17 (extremely difficult read) | 8 or less Auto. Read. Index | 6 (very easy read) to 14 (extremely difficult read) | 8 or less Coleman Liau Index | 6 (very easy read) to 17 (extremely difficult read) | 8 or less Dale-Chall Readability | 4.9 (very easy read) to 9.9 (extremely difficult read) | 6.9 or less
freakwriter commented 1 month ago

@nik8n and @ayatnkw the Google credentials are already highly detailed. I made some tweaks for readability but was curious if y'all had any other feedback on changes you'd like to see here.

@nik8n do you think we should update the YouTube videos here? I haven't touched any of the videos in the docs but it looks like the n8n UI is showing an older version...?

nik8n commented 1 month ago

A few things (let's discuss):

  1. Remove the Create a new credential in n8n section: I don't think we have this anywhere else, so why have it here?
  2. Why did you remove the OAUTH consent screen step? That is still needed, isn't it?
  3. The video definitely needs an update, but maybe let's do that later / as a separate action? It would make it easier to see the impact.
  4. I guess the video should come early (at the top of the page) normally. Maybe we can do that once we do (3)
freakwriter commented 1 month ago

@nik8n I didn't remove the OAuth consent screen; I reworded it to make it seem more required and added the note that you can skip it if you've done it before after the required step, so people would be less likely to skip it. It's now this:

Instead of this: If you haven't used OAuth in your Google Cloud project before, you need to configure the OAuth consent screen{:target=_blank .external-link}.

Since it seems like Google is one of the credentials people want to test with first, I suspect we're better off assuming they haven't configured a consent screen before than assuming they have.

I had wondered about that separate "New credential" thing at the top, too, since these are the only pages I've ever seen it on. I'm assuming it was done at some point in the past to help clarify what people needed to do, but I'm happy to rip it out.I've had some other ideas on ways to improve this, too, so I'll work all those in before I re-request review.

nik8n commented 1 month ago

Ahh, it's in the prerequisites now. Are you not afraid that this will get lost? I for example just skip the prerequisites every time. Also in user tests, we see that users are not actually reading the docs, but just skim over it really really quickly.

freakwriter commented 1 month ago

It was actually in both the prerequisites and the numbered instructions, but I'm revamping the instructions because I think the current layout encourages people to skip over steps. Give me a few more minutes!

On Tue, Jul 30, 2024 at 1:18 PM nik8n @.***> wrote:

Ahh, it's in the prerequisites now. Are you not afraid that this will get lost? I for example just skip the prerequisites every time. Also in user tests, we see that users are not actually reading the docs, but just skim over it really really quickly.

— Reply to this email directly, view it on GitHub https://github.com/n8n-io/n8n-docs/pull/2284#issuecomment-2258838496, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAKB7M3IWWTINNAKMWAY6N3ZO7DGHAVCNFSM6AAAAABLUY7MBSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENJYHAZTQNBZGY . You are receiving this because you authored the thread.Message ID: @.***>

freakwriter commented 1 month ago

@nik8n Turns out that the OAuth consent screen wasn't properly in the steps for the generic auth, which I think is what you were commenting on (I'd prioritized the single service one and somehow overlooked that the generic auth didn't have identical steps in it). They should be much more clearly laid out now and consistent with each other.

@ayatnkw I both added a screenshot of the dropdown and a link to create a new project directly, as I think they're both good suggestions.