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

[TT-13567] Review & update developer portal integration for streams #5732

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

Conversation

buraksezer
Copy link
Contributor

@buraksezer buraksezer commented Nov 19, 2024

User description

PR for https://tyktech.atlassian.net/browse/TT-13567


PR Type

Documentation


Description

  • Added a new documentation page for Tyk Streams, explaining how to publish Streams APIs to the Developer Portal.
  • Updated the menu configuration to include a link to the new Streams documentation page.

Changes walkthrough 📝

Relevant files
Documentation
streams.md
Add documentation for publishing Tyk Streams APIs               

tyk-docs/content/tyk-developer-portal/tyk-portal-classic/streams.md

  • Added a new documentation page for Tyk Streams.
  • Described how to publish Tyk Streams APIs to the Developer Portal.
  • Included metadata such as date, title, tags, and description.
  • +18/-0   
    menu.yaml
    Update menu to include Streams documentation                         

    tyk-docs/data/menu.yaml

  • Added a new menu entry for "Streams with Classic Portal".
  • Linked the new Streams documentation page in the menu.
  • +4/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant 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
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Nov 19, 2024

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

    Name Link
    🔨 Latest commit f0eeb4b
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673c562444025000086e851b
    😎 Deploy Preview https://deploy-preview-5732--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 Nov 19, 2024

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

    Name Link
    🔨 Latest commit d405547
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673eef171ca549000895ac59
    😎 Deploy Preview https://deploy-preview-5732--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.


    ## How To Set Up

    Simply create a Tyk Streams API, create a Policy which protects it, and then publish it to the Developer Portal Catalog.
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    We should add a reference to create streams API page (I this is the PR) & also add reference to publish API to developer portal catalog. If not available we should write it here.

    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.

    3 participants