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

[DX-1509] Update documentation for master #5067

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

buger
Copy link
Member

@buger buger commented Jul 11, 2024

User description

Triggered by: sredxny

Included:

Tyk Gateway: false
Tyk Dashboard: false
Tyk MDCB false
Tyk Pump true

Intended for: master
Changes sourced from: release-1.10
Config info generator branch: main

Note: (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/DX-1509


PR Type

Documentation


Description

  • Replaced instances of "whitelisted" with "allow list" for more inclusive language.
  • Replaced instances of "blacklisted" with "block list" for more inclusive language.
  • Corrected spelling from "organisation" to "organization" for consistency.
  • Corrected spelling from "authorise" to "authorize" for consistency.

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

    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
    Maintainability
    Ensure consistent terminology for "allow list" and "block list" throughout the document

    To maintain consistency and avoid confusion, consider using a uniform term for
    "allow list" and "block list" throughout the document. If "allow list" and "block
    list" are used, ensure these terms are used consistently across all sections.

    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. Ensure consistent terminology such as "allow list" is used throughout the document.
     
    Suggestion importance[1-10]: 8

    Why: Consistent terminology is important for maintainability and user comprehension. This suggestion addresses a key aspect of documentation clarity.

    8
    Enhancement
    Add explanatory text and examples to filter descriptions to enhance clarity

    Consider adding a brief explanation or example for each filter type to enhance
    clarity and user understanding. For instance, explain what constitutes an "allow
    list" or "block list" and possibly provide a sample configuration snippet.

    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, `org_ids: ["org1", "org2"]` allows data only from these organizations.
     
    Suggestion importance[1-10]: 7

    Why: Adding examples can enhance user understanding and make the documentation more practical. However, this is a minor improvement and not crucial for functionality.

    7
    Replace "block list" with "deny list" for clarity and to align with common terminology

    To avoid potential confusion with terminology, replace "block list" with "deny list"
    throughout the documentation. This change can help clarify the functionality and is
    becoming a more commonly accepted term in tech documentation.

    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]: 7

    Why: "Deny list" is becoming more commonly accepted and can help avoid confusion, but the current term "block list" is also understandable. This is a minor enhancement.

    7
    Best practice
    Convert environment variable listings to a table format for improved readability and structure

    For better readability and to adhere to best practices in documentation, consider
    using a table format to list and describe the environment variables and their types,
    instead of the current list format. This can make the document more structured and
    easier to navigate.

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

    -ENV: <b>TYK_PMP_PUMPS_CSV_FILTERS_ORGSIDS</b><br />
    -Type: `[]string`<br />
    +| Environment Variable                          | Type      |
    +| --------------------------------------------- | --------- |
    +| **TYK_PMP_PUMPS_CSV_FILTERS_ORGSIDS**         | `[]string`|
     
    Suggestion importance[1-10]: 6

    Why: Using a table format can improve readability and structure, but this is a stylistic choice and not essential for understanding the content.

    6

    Copy link

    netlify bot commented Jul 11, 2024

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

    Name Link
    🔨 Latest commit fefd1df
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/66904a6b4b82030008d11aaf
    😎 Deploy Preview https://deploy-preview-5067--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.

    Copy link

    netlify bot commented Jul 11, 2024

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

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

    @dcs3spp dcs3spp force-pushed the update/DX-1509/release-master-docs branch from fefd1df to 452656e Compare July 12, 2024 08:23
    Copy link
    Contributor

    @dcs3spp dcs3spp left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    PR LGTM thanks @sredxny

    @dcs3spp dcs3spp merged commit 81eb3ad into master Jul 12, 2024
    10 checks passed
    @dcs3spp dcs3spp deleted the update/DX-1509/release-master-docs branch July 12, 2024 08:47
    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Jul 12, 2024

    /release to release-5.4

    Copy link

    tykbot bot commented Jul 12, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jul 12, 2024
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    (cherry picked from commit 81eb3ad)
    Copy link

    tykbot bot commented Jul 12, 2024

    @dcs3spp Succesfully merged PR

    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Jul 12, 2024

    /release to release-5.3

    Copy link

    tykbot bot commented Jul 12, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jul 12, 2024
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    (cherry picked from commit 81eb3ad)
    Copy link

    tykbot bot commented Jul 12, 2024

    @dcs3spp Succesfully merged PR

    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Jul 12, 2024

    /release to release-5.2

    buger added a commit that referenced this pull request Jul 12, 2024
    )
    
    [DX-1509] Update documentation for master (#5067)
    
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    Copy link

    tykbot bot commented Jul 12, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jul 12, 2024
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    (cherry picked from commit 81eb3ad)
    Copy link

    tykbot bot commented Jul 12, 2024

    @dcs3spp Succesfully merged PR

    buger added a commit that referenced this pull request Jul 12, 2024
    )
    
    [DX-1509] Update documentation for master (#5067)
    
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    buger added a commit that referenced this pull request Jul 12, 2024
    )
    
    [DX-1509] Update documentation for master (#5067)
    
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Jul 12, 2024

    /release to release-5.1

    Copy link

    tykbot bot commented Jul 12, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jul 12, 2024
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    (cherry picked from commit 81eb3ad)
    Copy link

    tykbot bot commented Jul 12, 2024

    @dcs3spp Succesfully merged PR

    buger added a commit that referenced this pull request Jul 12, 2024
    )
    
    [DX-1509] Update documentation for master (#5067)
    
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Jul 12, 2024

    /release to release-5

    Copy link

    tykbot bot commented Jul 12, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jul 12, 2024
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    (cherry picked from commit 81eb3ad)
    Copy link

    tykbot bot commented Jul 12, 2024

    @dcs3spp Succesfully merged PR

    buger added a commit that referenced this pull request Jul 12, 2024
    [DX-1509] Update documentation for master (#5067)
    
    Import config/docs
    
    Co-authored-by: sredxny <[email protected]>
    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.

    3 participants