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

[DX 815] Draft: Improve Plugins Overview - Awaiting Plugin Bundle Overview Image #4918

Draft
wants to merge 53 commits into
base: master
Choose a base branch
from

Conversation

dcs3spp
Copy link
Contributor

@dcs3spp dcs3spp commented Jun 27, 2024

User description

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

DX-815

Note: PR has 5 content files, the remaining 8 files are images. Awaiting image for plugin bundles overview.


Preview Link

preview

Description

  • Improve Plugins Overview Page
  • Add Plugins API configuration section

Note: awaiting image for plugin bundles overview

Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • 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 labelled the PR

PR Type

Documentation, Enhancement


Description

  • Comprehensive update to the Plugins Overview page, including new sections for supported languages, plugin types, and configuration.
  • Added detailed documentation for configuring API plugins using source files and bundles for both Tyk Classic and Tyk OAS APIs.
  • Included configuration steps and screenshots for setting up plugins via Tyk Dashboard.
  • Reorganized the menu structure to include links to the new documentation pages.

Changes walkthrough 📝

Relevant files
Documentation
plugins.md
Comprehensive update to the Plugins Overview page.             

tyk-docs/content/plugins.md

  • Updated the overview and introduction to plugins.
  • Added sections for supported languages, how plugins work, plugin
    types, and plugin configuration.
  • Included a high-level architectural diagram and detailed configuration
    examples.
  • Added a "What's Next?" section with links to tutorials and resources.
  • +105/-21
    source-bundles.md
    Added documentation for configuring API plugins using bundles.

    tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/open-source/source-bundles.md

  • Added new documentation for configuring API plugins using bundles for
    Tyk Classic and Tyk OAS APIs.
  • Included configuration examples and explanations for both API types.
  • +75/-0   
    source-files.md
    Added documentation for configuring API plugins using source files.

    tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/open-source/source-files.md

  • Added new documentation for configuring API plugins using source files
    for Tyk Classic and Tyk OAS APIs.
  • Included detailed configuration examples and explanations for both API
    types.
  • +173/-0 
    source-bundles.md
    Added documentation for configuring API plugins using bundles via Tyk
    Dashboard.

    tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/self-managed/source-bundles.md

  • Added new documentation for configuring API plugins using bundles via
    Tyk Dashboard.
  • Included configuration steps and screenshots for both Tyk Classic and
    Tyk OAS APIs.
  • +32/-0   
    source-files.md
    Added documentation for configuring API plugins using source files via
    Tyk Dashboard.

    tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/self-managed/source-files.md

  • Added new documentation for configuring API plugins using source files
    via Tyk Dashboard.
  • Included configuration steps and screenshots for both Tyk Classic and
    Tyk OAS APIs.
  • +48/-0   
    Configuration changes
    menu.yaml
    Updated menu structure to include new plugin configuration
    documentation.

    tyk-docs/data/menu.yaml

  • Reorganized the menu structure to include new sections for API
    configuration.
  • Added links to new documentation pages for configuring plugins using
    source files and bundles.
  • +44/-16 

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link

    netlify bot commented Jun 27, 2024

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

    Name Link
    🔨 Latest commit 56578eb
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/667d7b3d7ebf5400085631d3
    😎 Deploy Preview https://deploy-preview-4918--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.

    1 similar comment
    Copy link

    netlify bot commented Jun 27, 2024

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

    Name Link
    🔨 Latest commit 56578eb
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/667d7b3d7ebf5400085631d3
    😎 Deploy Preview https://deploy-preview-4918--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 Jun 27, 2024

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

    Name Link
    🔨 Latest commit e88cb5d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/667d7b4dc83ad000088a4fab
    😎 Deploy Preview https://deploy-preview-4918--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 Jun 27, 2024

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

    Name Link
    🔨 Latest commit 8c5a78d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6686a7b8c96b2400085c99f4
    😎 Deploy Preview https://deploy-preview-4918--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.

    @dcs3spp dcs3spp changed the title [DX 815] Draft: Plugins Overview [DX 815] Draft: Improve Plugins Overview Jun 27, 2024
    @dcs3spp dcs3spp added the now label Jun 27, 2024
    @dcs3spp dcs3spp changed the title [DX 815] Draft: Improve Plugins Overview [DX 815] Improve Plugins Overview Jun 27, 2024
    @dcs3spp dcs3spp marked this pull request as ready for review June 27, 2024 17:01
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 4
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review Documentation Clarity:
    The PR includes extensive documentation updates. Ensure that all new links and references are valid and that the documentation is clear and easy to follow.
    Consistency:
    Review the consistency of terminology and formatting across the newly added sections. Ensure that the explanations are consistent with existing documentation standards.

    Copy link
    Contributor

    Failed to generate code suggestions for PR

    @dcs3spp dcs3spp changed the title [DX 815] Improve Plugins Overview [DX 815] Draft: Improve Plugins Overview - Awaiting Plugin Bundle Overview Image Jul 4, 2024
    @dcs3spp dcs3spp marked this pull request as draft July 4, 2024 13:52
    @dcs3spp dcs3spp removed the request for review from titpetric July 4, 2024 14:01
    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.

    None yet

    1 participant