Merging to release-5.4: [DX-1509] Update documentation for master (#5067)

[buger]

User description

DX-1509 Update documentation for master (#5067)

Import config/docs

Co-authored-by: sredxny [email protected]

---

PR Type

Documentation

---

Description

• Updated terminology in the pump configuration documentation to use more inclusive language:
  • Replaced "whitelisted" with "allow list".
  • Replaced "blacklisted" with "block list".
• Corrected spelling errors:
  • Changed "organisation" to "organization".
  • Changed "authorise" to "authorize".

---

Changes walkthrough 📝

	Relevant files
Documentation	pump-config.md Update terminology and correct spelling in pump configuration documentation. tyk-docs/content/shared/pump-config.md Replaced instances of "whitelisted" with "allow list". Replaced instances of "blacklisted" with "block list". Corrected spelling from "organisation" to "organization". Corrected spelling from "authorise" to "authorize". +122/-122

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Add warnings about the impacts of filter misconfiguration Since the filters are crucial for data management, adding a warning or note about the potential impact of misconfiguration could prevent user errors. This could include data loss or performance issues. tyk-docs/content/shared/pump-config.md [350] -Filters pump data by a block list of api_ids. +Filters pump data by a block list of api_ids. Note: Incorrect configuration of this filter can lead to unintended data exclusion, impacting analytics and reporting. Suggestion importance[1-10]: 9 Why: Adding warnings about the potential impacts of misconfiguration is crucial for preventing user errors that could lead to data loss or performance issues, making this a valuable addition to the documentation.	9
Enhancement	Add examples and explanations to filter descriptions to enhance clarity Consider adding a brief explanation or example for each filter type to enhance clarity and provide context on how the filters should be used or configured. This can help users understand the practical application and limitations of each filter. tyk-docs/content/shared/pump-config.md [326] -Filters pump data by an allow list of org_ids. +Filters pump data by an allow list of org_ids. For example, specify `["org1", "org2"]` to only include data from these organizations. Suggestion importance[1-10]: 8 Why: Providing examples and explanations can significantly improve the clarity and usability of the documentation, helping users understand how to configure the filters correctly.	8
Maintainability	Ensure consistent terminology in filter descriptions To maintain consistency and avoid confusion, consider using the same terminology across all filter descriptions. The term "allow list" and "block list" are used, but ensure these are consistently used across all documentation. tyk-docs/content/shared/pump-config.md [344] -Filters pump data by a block list of org_ids. +Filters pump data by a block list of org_ids. Ensure to use "block list" consistently in all filter descriptions where applicable. Suggestion importance[1-10]: 7 Why: Consistent terminology is important for maintainability and to avoid confusion among users. This suggestion helps ensure that the documentation is clear and professional.	7
Usability	Suggest adding a table of contents for better navigation To improve the accessibility and usability of the documentation, consider adding a table of contents at the beginning of the document that links to each filter section. This would help users quickly navigate to the relevant sections. tyk-docs/content/shared/pump-config.md [338] -Filters pump data by an allow list of response_codes. +Filters pump data by an allow list of response_codes. Consider adding a table of contents at the beginning of the document for easier navigation. Suggestion importance[1-10]: 6 Why: While adding a table of contents can improve usability and navigation, it is a minor enhancement compared to other suggestions. It is helpful but not critical.	6

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	adcec45
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/6690edbc0512110008f80e16
😎 Deploy Preview	https://deploy-preview-5070--tyk-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.

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	adcec45
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/6690edbc0512110008f80e16
😎 Deploy Preview	https://deploy-preview-5070--tyk-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.