Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

buger
Copy link
Member

@buger buger commented Jul 12, 2024

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 in the documentation:
    • 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 of "organisation" to "organization".
  • Corrected spelling of "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

    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    (cherry picked from commit 81eb3ad)
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    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.

    tyk-docs/content/shared/pump-config.md [344]

    -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.

    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 `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.

    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. 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.

    tyk-docs/content/shared/pump-config.md [332]

    -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.

    6

    Copy link

    netlify bot commented Jul 12, 2024

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

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

    1 similar comment
    Copy link

    netlify bot commented Jul 12, 2024

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

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

    @buger buger merged commit 39920ff into release-5.3 Jul 12, 2024
    10 checks passed
    @buger buger deleted the merge/release-5.3/81eb3ad0aa656747f198a1cbefddc70fcc6c4954 branch July 12, 2024 08:51
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant