Skip to content

New Page Request quotas #6297

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

Open
wants to merge 39 commits into
base: master
Choose a base branch
from
Open

New Page Request quotas #6297

wants to merge 39 commits into from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Apr 15, 2025

User description

Preview Link

https://deploy-preview-6297--tyk-docs.netlify.app/docs/nightly/api-management/request-quotas/

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors


PR Type

  • Documentation

Description

  • Added new Request Quotas docs page with detailed usage instructions.

  • Included mermaid diagram, configuration examples, and session object details.

  • Updated rate-limit page by cleaning up redundant alias entries.

  • Updated navigation menu to include Request Quotas link.


Changes walkthrough 📝

Relevant files
Documentation
rate-limit.md
Clean up aliases in rate-limit documentation.                       

tyk-docs/content/api-management/rate-limit.md

  • Removed redundant alias paths.
  • Streamlined alias list for clarity.
  • +0/-2     
    request-quotas.md
    Add new Request Quotas documentation page.                             

    tyk-docs/content/api-management/request-quotas.md

  • Added comprehensive Request Quotas documentation.
  • Explained quota configuration and usage details.
  • Provided mermaid diagram and code examples.
  • +204/-0 
    menu.yaml
    Update navigation menu with Request Quotas link.                 

    tyk-docs/data/menu.yaml

  • Added Request Quotas entry in the navigation menu.
  • Updated menu structure to include new documentation page.
  • +4/-0     

    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

    Metadata Consistency

    The front matter title is set to "Rate Limiting" which might be misleading given that the page content is about Request Quotas. Verify if the title should be updated to reflect the actual content.

    ---
    title: "Rate Limiting"
    date: 2025-01-10
    tags: [""]
    description: Overview of Rate Limiting with the Tyk Gateway
    keywords: [""]
    aliases:
      - /control-limit-traffic/request-quotas
      - /basic-config-and-security/control-limit-traffic/request-quotas
    ---
    Incomplete Metadata

    The tags and keywords fields are currently empty. Consider populating these with relevant descriptive terms to enhance searchability and consistency with other pages.

    ---
    title: "Rate Limiting"
    date: 2025-01-10
    tags: [""]
    description: Overview of Rate Limiting with the Tyk Gateway
    keywords: [""]
    aliases:
      - /control-limit-traffic/request-quotas
      - /basic-config-and-security/control-limit-traffic/request-quotas
    ---

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Apr 15, 2025

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

    Name Link
    🔨 Latest commit b64228c
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67fde7a7654b990008f04f9a
    😎 Deploy Preview https://deploy-preview-6297--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 15, 2025

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

    Name Link
    🔨 Latest commit 83cf2c7
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6809e47575d14700083eda02
    😎 Deploy Preview https://deploy-preview-6297--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