Skip to content

[TT-14490] Update documentation for master - Dashboard 5.8.1 #6336

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

Merged
merged 25 commits into from
May 12, 2025

Conversation

buger
Copy link
Member

@buger buger commented Apr 23, 2025

User description

Triggered by: mativm02

Included:

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

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

Note: Latest dashboard 5.8.1 updates (branch suffix: docs) (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/TT-14490


PR Type

Documentation


Description

  • Added header images to Dashboard API documentation.

  • Updated default dashboard host port to 3000.

  • Changed duration fields to string format with examples.

  • Improved API documentation clarity and formatting.


Changes walkthrough 📝

Relevant files
Documentation
dashboard-admin-swagger.yml
Add header image to Dashboard Admin API docs                         

tyk-docs/assets/others/dashboard-admin-swagger.yml

  • Added a header image to the API documentation description.
  • Enhanced visual presentation of the documentation.
  • +2/-0     
    dashboard-swagger.yml
    Update images, port, and duration format in Dashboard API docs

    tyk-docs/assets/others/dashboard-swagger.yml

  • Inserted a header image at the top of the documentation.
  • Changed default dashboard host port from 8080 to 3000.
  • Updated duration fields to use string format with examples.
  • Improved documentation formatting and clarity.
  • +9/-6     

    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

    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

    Documentation Format Change

    The TimeDuration and TimeReadableDuration schema types have been changed from integer to string with duration formats and examples. Reviewers should ensure that this change is consistent with the actual API behavior and that all documentation and client expectations are updated accordingly.

      format: duration
      type: string
      example: "30s"
    TimeReadableDuration:
      format: duration
      type: string
      example: PT2H30M15S
    Default Host Port Update

    The default dashboard host port was changed from 8080 to 3000. Confirm that this reflects the actual default in the product and that all related documentation and configuration references are consistent.

    default: localhost:3000
    description: Your dashboard host

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @mativm02 mativm02 changed the title [TT-14490] Update documentation for master [TT-14490] Update documentation for master - Dashboard 5.8.1 Apr 23, 2025
    Copy link

    netlify bot commented Apr 23, 2025

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

    Name Link
    🔨 Latest commit 5fbe360
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6808c76be9e0aa00086eb520
    😎 Deploy Preview https://deploy-preview-6336--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 Apr 23, 2025

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

    Name Link
    🔨 Latest commit b1e47ec
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/68219be1dc4bc200088b1162
    😎 Deploy Preview https://deploy-preview-6336--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.

    @mativm02 mativm02 requested a review from sharadregoti April 24, 2025 10:24
    @ilijabojanovic ilijabojanovic merged commit 7c7b796 into master May 12, 2025
    12 checks passed
    @ilijabojanovic ilijabojanovic deleted the update/TT-14490/release-master-docs branch May 12, 2025 07:00
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.8

    Copy link

    tykbot bot commented May 12, 2025

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

    tykbot bot pushed a commit that referenced this pull request May 12, 2025
    Import config/docs
    
    Co-authored-by: mativm02 <83959431+mativm02@users.noreply.github.com>
    (cherry picked from commit 7c7b796)
    Copy link

    tykbot bot commented May 12, 2025

    @sharadregoti Created merge PRs

    buger added a commit that referenced this pull request May 12, 2025
    …Dashboard 5.8.1 (#6336)
    
    [TT-14490] Update documentation for master - Dashboard 5.8.1 (#6336)
    
    Import config/docs
    
    Co-authored-by: mativm02 <83959431+mativm02@users.noreply.github.com>
    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.

    4 participants