-
Notifications
You must be signed in to change notification settings - Fork 150
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
base: master
Are you sure you want to change the base?
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
✅ PS. Pls add /docs/nightly to the end of url
To edit notification comments on pull requests, go to your Netlify site configuration. |
@@ -0,0 +1,136 @@ | |||
--- |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
@titpetric The missing bit for me is when do I use this vs when to use the compiler |
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
master
.PR Type
Documentation
Description
Changes walkthrough 📝
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
workspace.
issues.