n8n-docs
n8n-docs copied to clipboard
DOC-1116: Google Sheets node updates
Summary of changes:
- Move troubleshooting stuff to its own "Common issues" page
- Test using a cards layout for the operations list, instead of the bullet point list
Deploy Preview for n8n-docs ready!
| Name | Link |
|---|---|
| Latest commit | 50239f8741ff522e6b537a26d331cece9e499b1d |
| Latest deploy log | https://app.netlify.com/sites/n8n-docs/deploys/66f30100bd250c0008d3fbb6 |
| Deploy Preview | https://deploy-preview-2485--n8n-docs.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
Overall readability score: 44.18 (🟢 +0.02)
| File | Readability |
|---|---|
| common-issues.md | 83.05 (-) |
| index.md | 43.9 (🔴 -17) |
View detailed metrics
🟢 - Shows an increase in readability 🔴 - Shows a decrease in readability
| File | Readability | FRE | GF | ARI | CLI | DCRS |
|---|---|---|---|---|---|---|
| common-issues.md | 83.05 | 77.64 | 6 | 6.9 | 8.68 | 7.44 |
| - | - | - | - | - | - | |
| index.md | 43.9 | 39.84 | 11.55 | 14.1 | 14.09 | 9.09 |
| 🔴 -17 | 🔴 -18.34 | 🔴 -2.22 | 🔴 -2.6 | 🔴 -2.16 | 🔴 -1.04 |
Averages:
| Readability | FRE | GF | ARI | CLI | DCRS | |
|---|---|---|---|---|---|---|
| Average | 44.18 | 35.32 | 11.46 | 14.7 | 14.26 | 8.47 |
| 🟢 +0.02 | 🟢 +0.02 | 🟢 +0 | 🟢 +0 | 🟢 +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 |
@nik8n I know we've both not loved the bullet point list of operations in the nodes. While I was adding a separate common issues page for Google Sheets, I played around with using a cards layout for the operations list instead.
Curious what you and @imchairmanm think--you should be able to compare this to the current Google Sheets node doc. I can flip back to the bullet point list if we don't like this, but figured I'd give you an option. :)
@freakwriter The cards are interesting. I don't think I've gathered all of my thoughts yet, but my initial reaction is:
- I think the categories ("Document" and "Sheet Within Document") look better as subheadings than bullets
- The title + link name in the cards seem a bit repetitive to me
- I think space that cards occupy would be a better tradeoff if we could figure out a way to make the whole element act as a link instead of just the URL. Not sure how well that fits with how the card mkdoc's card component is designed though.
- Personally, I think my eyes have a bit easier time parsing items that are only arranged on one axis (vertical or horizontal), so the cards are a bit more difficult to scan for me.
All of that being said, I don't know much about the pain points you all have experienced, so feel free to disregard.
Common issues looks good. In the format, I kinda like the bullet-list a little more I think. The new format takes quite a lot of space and it's hard to scan for me.
Okay good. I wasn't loving the cards either but wanted to present all the options, so I'll shift us back to the bullet point list.
Okay, cards are removed and it sounded like the other changes were okay--would one of you be able to approve?