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-13263/TT-13264] Add plugin development docs update #5565

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

Conversation

titpetric
Copy link
Contributor

@titpetric titpetric commented Oct 11, 2024

User description

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


Updates local development docs for the latest releases, documenting go workspaces.

Task: https://tyktech.atlassian.net/browse/TT-13263
Parent: https://tyktech.atlassian.net/browse/TT-13264

Preview: https://deploy-preview-5565--tyk-docs.netlify.app/nightly/docs/product-stack/tyk-gateway/advanced-configurations/plugins/golang/go-development-flow/


Preview Link


Description


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


Description

  • Updated the Go plugin development documentation to provide a comprehensive guide for setting up the environment and creating a Go workspace.
  • Added instructions for checking out the Tyk Gateway, preparing the plugin workspace, and creating a Go workspace.
  • Included steps for testing plugins and ensuring compatibility with the Tyk Gateway.
  • Addressed common issues related to plugin compilation and build flag restrictions.
  • Enhanced the clarity and structure of the documentation for better understanding.

Changes walkthrough 📝

Relevant files
Documentation
go-development-flow.md
Update Go Plugin Development Documentation with Detailed Steps

tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/golang/go-development-flow.md

  • Updated the documentation for Go plugin development flow.
  • Added detailed steps for setting up the environment and creating a Go
    workspace.
  • Included instructions for testing plugins and addressing common
    issues.
  • Enhanced clarity on compatibility and build flag restrictions.
  • +83/-115

    💡 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: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Clarity
    The new documentation should ensure clarity and completeness in explaining the setup and usage of Go plugins. It's crucial to verify that all steps are clear, especially for users unfamiliar with Go workspaces or those transitioning from older versions of Tyk.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Oct 11, 2024

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

    Name Link
    🔨 Latest commit 29f3c89
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/670d0357ec0716000884bf12
    😎 Deploy Preview https://deploy-preview-5565--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.

    @@ -0,0 +1,136 @@
    ---
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    In general, we need to add new files to menu.yaml.
    In this case, why not add the content in this to the bottom of the other file?

    ---

    Go plugins must be compiled before they can be run. This applies to custom code that you want Tyk to run during the processing of API requests and responses in [custom plugins]({{< ref "plugins" >}}). In this section we describe the process and highlight important information that you must be aware of when working with custom Go plugins.
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    @titpetric regarding the steps shown in this page, is it for all versions of gateway or only for version tyk-release-5.3.6?

    Because the live version of this doc has different initialization method for each version. Especially versions #prior to 4.2

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    It's valid for the latest 5.3 LTS; previous versions would remain documented on their respective release branches. 5.3.6 is likely the minimum, due to the Go version bump, but this should apply to 5.3.7 and future 5.3 releases.

    @letzya
    Copy link
    Collaborator

    letzya commented Oct 21, 2024

    @titpetric The missing bit for me is when do I use this vs when to use the compiler

    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