tyk-docs icon indicating copy to clipboard operation
tyk-docs copied to clipboard

[DX-1652] Plugin Bundle CLI Improvements

Open dcs3spp opened this issue 5 months ago • 3 comments

User description

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

DX-1652


Preview Link

preview

Description

Improve bundle CLI content to give required prerequisites following previous review

Screenshots (if appropriate)


Checklist

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

PR Type

documentation


Description

  • Added a new section on prerequisites for creating plugin bundles, detailing necessary files like manifest.json, plugin source code files, and optional certificate keys.
  • Provided a suggested directory structure for organizing plugin bundles in Golang, Javascript, and Python.
  • Included a Docker example for creating plugin bundles for Tyk Gateway versions earlier than 5.5, detailing the command and its purpose.
  • Enhanced the documentation with additional command options and notes for creating plugin bundles, improving clarity and usability.

Changes walkthrough 📝

Relevant files
Documentation
bundle-cli.md
Enhance Plugin Bundle CLI Documentation with Prerequisites and Docker
Example

tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/bundles/bundle-cli.md

  • Added prerequisites section detailing required files and
    configurations for plugin bundles.
  • Introduced a directory structure guide for Golang, Javascript, and
    Python bundles.
  • Added a Docker example for creating plugin bundles for Gateway
    versions
  • Enhanced documentation with command options and additional notes for
    bundle creation.
  • +86/-5   

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

    dcs3spp avatar Sep 12 '24 14:09 dcs3spp