n8n-docs icon indicating copy to clipboard operation
n8n-docs copied to clipboard

Doc 831 Clarify explanation around data pruning and env vars related to external storage

Open ayatnkw opened this issue 9 months ago • 2 comments

Changes

Added note about binary data pruning on the environment variables page.

Related tickets and issues

Forum: Several Documentation Errors Related PR: https://github.com/n8n-io/n8n-docs/pull/2031

Partially resolves Issue https://github.com/n8n-io/n8n-docs/issues/1995

ayatnkw avatar May 03 '24 12:05 ayatnkw

Deploy Preview for n8n-docs ready!

Name Link
Latest commit 8d51c268c940bdb92edcdf450b87adcaa8db045b
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/663b8fc6ee38760008812260
Deploy Preview https://deploy-preview-2083--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.

netlify[bot] avatar May 03 '24 12:05 netlify[bot]

Overall readability score: 45.26 (🟢 +0)

File Readability
binary-data-pruning.md 63.39 (-)
binary-data.md 67.37 (🟢 +6.68)
binary-data.md 61.73 (🔴 -14.61)
execution-data.md 48.04 (🔴 -3.59)
external-storage.md 35.67 (🔴 -6.94)
View detailed metrics

🟢 - Shows an increase in readability 🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
binary-data-pruning.md 63.39 48.5 10.37 9.6 9.79 8.02
  - - - - - -
binary-data.md 67.37 43.19 8.41 9.1 10.59 7.43
  🟢 +6.68 🟢 +7.35 🟢 +0.7 🟢 +0.9 🟢 +0.98 🟢 +0.49
binary-data.md 61.73 39.84 10.49 9.5 10.32 7.84
  🔴 -14.61 🔴 -12.82 🔴 -1.7 🔴 -3.1 🔴 -2.23 🔴 -0.6
execution-data.md 48.04 34.66 11.75 14.4 13 7.77
  🔴 -3.59 🔴 -8.36 🟢 +0.2 🔴 -0.9 🔴 -0.7 🔴 -0.08
external-storage.md 35.67 25.53 14.71 18.2 12.66 8
  🔴 -6.94 🔴 -9.67 🔴 -0.52 🔴 -1.4 🔴 -1.05 🔴 -0.29

Averages:

  Readability FRE GF ARI CLI DCRS
Average 45.26 38.96 11.89 14.37 13.54 8.56
  🟢 +0 🔴 -0.01 🟢 +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

github-actions[bot] avatar May 03 '24 12:05 github-actions[bot]

@ayatnkw I'vbe moved the note inline with the relevant env var - I don't want to overuse notes, and I don't think most people will need to worry about this info.

I think a bit more work is needed on this ticket. Can you check if we currently have anywhere in the docs that explains binary data pruning (I don't think we do - but check), and if necessary create a page in the "Scaling and Performance" section (similar to the "Execution data" page). You can then link to that page from the places where binary data pruning is mentioned.

StarfallProjects avatar May 07 '24 07:05 StarfallProjects