Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TT-12885] Add plugin development guide for manual builds (#6598)
### **User description** <details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-12885" title="TT-12885" target="_blank">TT-12885</a></summary> <br /> <table> <tr> <th>Summary</th> <td>[Plugin docs] Provide guidance on compiling plugins manually</td> </tr> <tr> <th>Type</th> <td> <img alt="Story" src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium" /> Story </td> </tr> <tr> <th>Status</th> <td>In Dev</td> </tr> <tr> <th>Points</th> <td>N/A</td> </tr> <tr> <th>Labels</th> <td>-</td> </tr> </table> </details> <!-- do not remove this marker as it will break jira-lint's functionality. added_by_jira_lint --> --- https://tyktech.atlassian.net/browse/TT-12885 ___ ### **PR Type** Documentation, Enhancement ___ ### **Description** - Added a comprehensive guide for Go plugin development, detailing environment setup, workspace creation, and plugin testing. - Introduced Taskfiles for automating markdown formatting and plugin development tasks, enhancing workflow efficiency. - Fixed indentation issues in the swagger documentation to improve readability. ___ ### **Changes walkthrough** 📝 <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Configuration changes</strong></td><td><table> <tr> <td> <details> <summary><strong>Taskfile.yml</strong><dd><code>Add Taskfile for markdown formatting with mdox</code> </dd></summary> <hr> docs/Taskfile.yml <li>Added a Taskfile for managing markdown formatting tasks.<br> <li> Introduced a default task to run <code>mdox</code> for formatting markdown files. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6598/files#diff-490292b48d08097a4846f074704602500f054c4b9272545224d27b5ad0e24ca0">+8/-0</a> </td> </tr> <tr> <td> <details> <summary><strong>Taskfile.yml</strong><dd><code>Add Taskfile for automating plugin development tasks</code> </dd></summary> <hr> docs/plugins/Taskfile.yml <li>Added a Taskfile for automating plugin development tasks.<br> <li> Defined tasks for checking out repositories, creating workspaces, and <br>testing plugins. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6598/files#diff-d9772a9122a4c0e8eeb789a79dbe91a293a2f6b6ca72b43fbb73c62eef30d7de">+61/-0</a> </td> </tr> </table></td></tr><tr><td><strong>Documentation</strong></td><td><table> <tr> <td> <details> <summary><strong>README.md</strong><dd><code>Add comprehensive Go plugin development guide</code> </dd></summary> <hr> docs/plugins/README.md <li>Added a comprehensive guide for Go plugin development.<br> <li> Included steps for setting up the environment, creating workspaces, <br>and testing plugins.<br> <li> Provided troubleshooting tips for common issues and debugging. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6598/files#diff-aae529ed8d07326b707ba5a2998f0f5c0dea06651de706ea951c105d966417e2">+245/-0</a> </td> </tr> </table></td></tr><tr><td><strong>Formatting</strong></td><td><table> <tr> <td> <details> <summary><strong>swagger.md</strong><dd><code>Fix indentation in swagger generation documentation</code> </dd></summary> <hr> docs/swagger.md <li>Fixed indentation issues in the documentation for generating swagger <br>files. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6598/files#diff-0d3265e8be331704b75414619e8cf0fcf63cdce0bcb13ae1df64cf99e8e42b20">+2/-2</a> </td> </tr> </table></td></tr></tr></tbody></table> ___ > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information --------- Co-authored-by: Tit Petric <[email protected]>
- Loading branch information