You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace "block list" with "deny list" to align with inclusive language standards
To maintain consistency in terminology, consider replacing "block list" with "deny list" if it aligns with your project's inclusive language goals. This change should be reflected across all relevant documentation sections.
-Filters pump data by a block list of org_ids.+Filters pump data by a deny list of org_ids.
Suggestion importance[1-10]: 8
Why: Aligning with inclusive language standards is important for maintaining a respectful and modern documentation style.
8
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 user understanding. This could include what constitutes an org_id, api_id, or response_code, and how they should be formatted or used in the context of these filters.
-Filters pump data by an allow list of org_ids.+Filters pump data by an allow list of org_ids. For example, specify `org_id` values like "123", "456" to only include data related to these organizations.
Suggestion importance[1-10]: 7
Why: Adding examples and explanations can improve user understanding and usability, but it is not critical for functionality.
7
Clarity
Specify if the filters are case-sensitive to prevent user confusion
To avoid potential confusion, explicitly mention whether the filters are case-sensitive or not. This information helps users understand how precisely they need to match the org_ids, api_ids, or response_codes.
-Filters pump data by an allow list of response_codes.+Filters pump data by an allow list of response_codes. Note: The filtering is case-sensitive.
Suggestion importance[1-10]: 7
Why: Mentioning case sensitivity can prevent user errors and confusion, enhancing clarity and usability.
7
Clarify the expected data types in filter descriptions
It's beneficial to specify the expected data type for the org_ids, api_ids, and response_codes in the filter descriptions. This ensures users know what data format to use, such as integers or strings.
-Filters pump data by an allow list of api_ids.+Filters pump data by an allow list of api_ids. Ensure to use string identifiers like "api_001", "api_002".
Suggestion importance[1-10]: 6
Why: Specifying data types can help avoid user errors, but the current descriptions are already somewhat clear.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
DX-1509 Update documentation for master (#5067)
Import config/docs
Co-authored-by: sredxny [email protected]
PR Type
Documentation
Description
Changes walkthrough 📝
pump-config.md
Update terminology and correct spelling in pump configuration
documentation
tyk-docs/content/shared/pump-config.md