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

Manual triggered: Import config documentation from dashboard:master #6059

Closed
wants to merge 1 commit into from

Conversation

buger
Copy link
Member

@buger buger commented Mar 4, 2025

User description

Automated changes by create-pull-request GitHub action


PR Type

Documentation


Description

  • Added storage.main DB type and connection fields.

  • Added analytics, logs, and uptime DB config options.

  • Updated Redis and TLS documentation links.

  • Introduced onboarding UI wizard configuration.


Changes walkthrough 📝

Relevant files
Documentation
dashboard-config.md
Expanded database configuration and onboarding docs           

tyk-docs/content/shared/dashboard-config.md

  • Added new documentation sections for storage.main configurations.
  • Added configuration details for analytics, logs, and uptime.
  • Updated Redis and TLS doc links.
  • Introduced onboarding UI wizard configuration details.
  • +163/-4 

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    github-actions bot commented Mar 4, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Typo

    The new onboarding UI section uses the word "wizzard" instead of "wizard". Please review and correct the spelling for consistency.

    ### ui.onboarding
    Onboarding section defines the information about the onboarding UI wizzard flow.
    
    ### ui.onboarding.enabled
    ENV: <b>TYK_DB_UI_ONBOARDING_ENABLED</b><br />
    Type: `bool`<br />
    
    Enabled is a boolean flag that enables the onboarding UI wizzard flow.
    

    Copy link
    Contributor

    github-actions bot commented Mar 4, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix onboarding typo

    Correct the spelling of wizzard to wizard in the onboarding section for clarity.

    tyk-docs/content/shared/dashboard-config.md [1076]

    -Enabled is a boolean flag that enables the onboarding UI wizzard flow.
    +Enabled is a boolean flag that enables the onboarding UI wizard flow.
    Suggestion importance[1-10]: 6

    __

    Why: The suggestion identifies and corrects a clear spelling error ("wizzard" to "wizard") in the onboarding section, a minor but useful improvement for clarity.

    Low

    Copy link

    netlify bot commented Mar 4, 2025

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

    Name Link
    🔨 Latest commit 4913c0f
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67c6c0b5b803340008155fd7
    😎 Deploy Preview https://deploy-preview-6059--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.

    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