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-1398] Update tyk-pump-dashboard-config.md (#5078) #5112

Merged

Conversation

buger
Copy link
Member

@buger buger commented Jul 23, 2024

User description

DX-1398 Update tyk-pump-dashboard-config.md (#5078)

Update tyk-pump-dashboard-config.md


PR Type

Documentation


Description

  • Updated the Tyk Dashboard configuration documentation to reflect changes in the configuration structure.
  • Replaced the sql, sql_aggregate, and uptime_pump_config sections with a unified storage section.
  • Added new subsections main, analytics, logs, and uptime under the storage section, each with table_sharding configuration.

Changes walkthrough 📝

Relevant files
Documentation
tyk-pump-dashboard-config.md
Update Tyk Dashboard configuration structure for table sharding

tyk-docs/content/tyk-pump/tyk-pump-configuration/tyk-pump-dashboard-config.md

  • Updated configuration structure for Tyk Dashboard.
  • Replaced sql, sql_aggregate, and uptime_pump_config with storage
    sections.
  • Added main, analytics, logs, and uptime under storage.
  • +18/-18 

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

    Update tyk-pump-dashboard-config.md
    
    (cherry picked from commit 5e72eab)
    Copy link
    Contributor

    PR Reviewer Guide 🔍

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

    Copy link
    Contributor

    github-actions bot commented Jul 23, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Centralize the table_sharding configuration to reduce redundancy

    It appears that the table_sharding configuration is repeated across multiple
    sections (main, analytics, logs, uptime). If table_sharding is intended to have the
    same setting across these different storage types, consider centralizing this
    configuration to reduce redundancy and simplify future updates.

    tyk-docs/content/tyk-pump/tyk-pump-configuration/tyk-pump-dashboard-config.md [441-457]

     "storage": {
    +  "default_settings": {
    +    "table_sharding": true
    +  },
       "main": {
         ...
    -    "table_sharding": true
       },
       "analytics": {
         ...
    -    "table_sharding": true
       },
       "logs": {
         ...
    -    "table_sharding": true
       },
       "uptime": {
         ...
    -    "table_sharding": true
       }
     },
     
    Suggestion importance[1-10]: 8

    Why: The suggestion to centralize the table_sharding configuration is logical and improves maintainability by reducing redundancy. This change simplifies future updates and ensures consistency across different storage types.

    8

    Copy link

    netlify bot commented Jul 23, 2024

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

    Name Link
    🔨 Latest commit 217964f
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/669f739820ae640008bd6601
    😎 Deploy Preview https://deploy-preview-5112--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 23, 2024

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

    Name Link
    🔨 Latest commit 217964f
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/669f739820ae640008bd6601
    😎 Deploy Preview https://deploy-preview-5112--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 e5d3322 into release-5.3 Jul 23, 2024
    9 checks passed
    @buger buger deleted the merge/release-5.3/5e72eab85e475943ceb9c14514b3d186c4c18e5d branch July 23, 2024 09:12
    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.

    2 participants