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

New IA - Automations #5689

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

New IA - Automations #5689

wants to merge 58 commits into from

Conversation

DavidRollins
Copy link
Collaborator

@DavidRollins DavidRollins commented Nov 1, 2024

User description

For internal users - Please add a Jira DX PR ticket to the subject!



Preview Link

https://deploy-preview-5689--tyk-docs.netlify.app/docs/nightly/api-management/automations/

Description

  1. Describe your changes in detail. Why is this change required? What problem does it solve?
    Add automations page to highlight Tyk operator, streams, and mdcb features - api lifecycle automations

  2. Please explain the change to the reviewer. Pay special attention to changes that are hard to spot,
    for example:
    2.1. Name change in the file name or directory name - please flag it out since it’s hard
    to compare text after such a change
    2.2. Terminology change - flag it out to make sure the reviewer is aware before approving

    1. @mentions of the person to review the proposed changes. They need to be able to know the topic well in order to approve it.

Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labeled the PR

PR Type

Documentation, Enhancement


Description

  • Added a new documentation page detailing Tyk's automation tools for API management, including Tyk Operator, Tyk Sync, and API security configuration.
  • Provided examples for setting up various API types such as HTTP, TCP, UDG, and GraphQL using Tyk Operator.
  • Included instructions for automating multi-environment deployments using GitHub Actions.
  • Updated the menu configuration to include the new Automations page, improving navigation.

Changes walkthrough 📝

Relevant files
Documentation
automations.md
Add comprehensive guide on Tyk automation tools                   

tyk-docs/content/api-management/automations.md

  • Added a comprehensive guide on Tyk automation tools for API
    management.
  • Included sections on Tyk Operator, Tyk Sync, and API security
    configuration.
  • Provided examples for setting up various API types and automating
    deployments.
  • Added troubleshooting and FAQ section for common issues.
  • +1349/-0
    Configuration changes
    menu.yaml
    Update menu to include Automations page                                   

    tyk-docs/data/menu.yaml

  • Added a new menu entry for the Automations page.
  • Updated the menu structure to include the new documentation.
  • +4/-0     

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

    Copy link
    Contributor

    github-actions bot commented Nov 1, 2024

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Content Volume
    The document is extremely lengthy and detailed, which might overwhelm users. Consider breaking it into smaller, focused sub-documents.

    Possible Redundancy
    There are multiple sections that seem to repeat information about API types and features. Review to ensure content is not unnecessarily duplicated.

    Technical Details
    The document includes complex technical details and configurations that might need additional context or simplification for better understanding.

    Copy link
    Contributor

    github-actions bot commented Nov 1, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Nov 1, 2024

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

    Name Link
    🔨 Latest commit 515b9da
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67251276c3f86b000717cf6b
    😎 Deploy Preview https://deploy-preview-5689--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 1, 2024

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

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

    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    @sharadregoti sharadregoti mentioned this pull request Nov 6, 2024
    6 tasks
    Copy link
    Contributor

    @sharadregoti sharadregoti left a comment

    Choose a reason for hiding this comment

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

    Overall content looks good to me.

    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    @sharadregoti sharadregoti changed the title Automations new ia New IA - Automations new ia Nov 14, 2024
    @sharadregoti sharadregoti changed the title New IA - Automations new ia New IA - Automations Nov 14, 2024
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    tyk-docs/content/api-management/automations.md Outdated Show resolved Hide resolved
    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