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.

Sign up for GitHub

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

Jump to bottom

New section & guide on the UI for Streams #5721

Merged
merged 13 commits into from
Nov 27, 2024
Merged

New section & guide on the UI for Streams #5721

merged 13 commits into from
Nov 27, 2024

Conversation

jay-deshmukh
Copy link
Contributor

@jay-deshmukh jay-deshmukh commented Nov 15, 2024 •
edited by github-actions bot
Loading

User description

Docs for creating streaming API using dashboard UI

PR Type

Documentation

Description

  • Added a comprehensive guide for configuring a Streams API using the Dashboard UI, detailing steps for setup, authentication, and access control.
  • Updated the documentation menu to include a new entry for the Streams API configuration guide, ensuring easy navigation.

Changes walkthrough 📝

Relevant files
Documentation
streams-configuration-using-ui.md
Add guide for configuring Streams API using Dashboard UI 

tyk-docs/content/product-stack/tyk-streaming/streams-configuration-using-ui.md

  • Added a new guide for configuring Streams API using the Dashboard UI.
  • Included detailed steps for creating, configuring, and securing a
    Streams API.
  • Provided instructions for creating policies and generating keys for
    API access.
  • Added images to illustrate the process.
    		•  +103/-0 
    Configuration changes
    menu.yaml
    Update menu to include Streams API configuration guide     

    tyk-docs/data/menu.yaml

  • Added a new menu entry for the Streams API configuration guide.
  • Updated the menu to include the new documentation path.
    		•  +4/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @netlify Netlify
    Copy link

    netlify bot commented Nov 15, 2024 •
    edited
    Loading

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

    Name Link
    🔨 Latest commit d711da8
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673724e0f77b830008b5ddc2
    😎 Deploy Preview https://deploy-preview-5721--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.

    @netlify Netlify
    Copy link

    netlify bot commented Nov 15, 2024 •
    edited
    Loading

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

    Name Link
    🔨 Latest commit b2def8a
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6746c2def736e2000869b994
    😎 Deploy Preview https://deploy-preview-5721--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.

    @jay-deshmukh jay-deshmukh marked this pull request as ready for review November 15, 2024 12:03
    @github-actions GitHub Actions
    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
    ⚡ No major issues detected

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @sharadregoti sharadregoti mentioned this pull request Nov 21, 2024
    Merged
    @sharadregoti sharadregoti merged commit a399110 into master Nov 27, 2024
    9 checks passed
    @sharadregoti sharadregoti deleted the feat/streams-ui branch November 27, 2024 07:02
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @buraksezer buraksezer buraksezer approved these changes

    @sharadregoti sharadregoti sharadregoti approved these changes

    @pvormste pvormste Awaiting requested review from pvormste

    @kofoworola kofoworola Awaiting requested review from kofoworola

    @agata-wit agata-wit Awaiting requested review from agata-wit

    Assignees
    No one assigned
    Labels
    5.7.0 Peer Review Done Review effort [1-5]: 2
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @jay-deshmukh @sharadregoti @buraksezer