Skip to content

Update rich-plugins.md #6586

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

Open
wants to merge 4 commits into
base: letz-navigation-fix
Choose a base branch
from
Open

Conversation

yurisasuke
Copy link
Member

@yurisasuke yurisasuke commented Jun 25, 2025

User description

Preview Link

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors


PR Type

Documentation


Description

  • Corrected internal documentation links for .NET and NodeJS tutorials

  • Updated references to use consistent naming for .NET plugin guides

  • Ensured tutorial links point to the correct sections

  • Improved navigation for gRPC plugin development resources


Changes walkthrough 📝

Relevant files
Documentation
rich-plugins.md
Corrected and unified .NET/NodeJS tutorial links in documentation

tyk-docs/content/api-management/plugins/rich-plugins.md

  • Fixed incorrect internal links for .NET and NodeJS tutorial sections
  • Updated link text to consistently use "custom-auth-plugin-with-dotnet"
  • Improved accuracy and consistency of gRPC plugin guide references
  • +2/-2     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @yurisasuke yurisasuke requested a review from letzya June 25, 2025 05:24
    Copy link
    Contributor

    ⚠️ Deploy preview for PR #6586 did not become live after 3 attempts.
    Please check Netlify or try manually: Preview URL

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Broken Link

    The link for the .NET tutorial in the "What's Next?" section appears to have a typo in the anchor (dotne instead of dotnet), which may result in a broken or incorrect link.

    - Visit tutorial guides that explain how to implement a [Java]({{< ref "api-management/plugins/rich-plugins#create-a-request-transformation-plugin-with-java" >}}), [.NET]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotne" >}}) and [NodeJS]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}) gRPC server.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Fix typo in documentation link anchor

    The link for the .NET tutorial contains a typo in the anchor ("dotne" instead of
    "dotnet"), which will result in a broken link. Correct the anchor to "dotnet" to
    ensure the documentation link works as intended.

    tyk-docs/content/api-management/plugins/rich-plugins.md [1485]

    -- Visit tutorial guides that explain how to implement a [Java]({{< ref "api-management/plugins/rich-plugins#create-a-request-transformation-plugin-with-java" >}}), [.NET]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotne" >}}) and [NodeJS]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}) gRPC server.
    +- Visit tutorial guides that explain how to implement a [Java]({{< ref "api-management/plugins/rich-plugins#create-a-request-transformation-plugin-with-java" >}}), [.NET]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}) and [NodeJS]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}) gRPC server.
    Suggestion importance[1-10]: 8

    __

    Why: The suggestion correctly identifies and fixes a typo in the .NET tutorial link anchor, which would otherwise result in a broken documentation link. This directly improves the usability and accuracy of the documentation.

    Medium

    @@ -17,7 +17,7 @@ aliases:
    - /plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin
    - /plugins/supported-languages/rich-plugins/grpc/getting-started-python
    - /plugins/supported-languages/rich-plugins/grpc/request-transformation-java
    - /plugins/supported-languages/rich-plugins/grpc/custom-auth-dot-net
    - /plugins/supported-languages/rich-plugins/grpc/custom-auth-dot-
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    what is that @yurisasuke

    Copy link
    Member Author

    Choose a reason for hiding this comment

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

    what is that @yurisasuke

    That one should not have been changed. I have returned it back to /plugins/supported-languages/rich-plugins/grpc/custom-auth-dot-net .

    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.

    2 participants