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.

Sign up for GitHub

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

Jump to bottom

[TT-13731] Fixes bundle plugin sub-directory problem. #5831

Merged
merged 7 commits into from
Jan 14, 2025
Merged

[TT-13731] Fixes bundle plugin sub-directory problem. #5831

merged 7 commits into from
Jan 14, 2025

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Dec 18, 2024 •
edited
Loading

User description

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


Preview Link


https://deploy-preview-5831--tyk-docs.netlify.app/docs/nightly/product-stack/tyk-gateway/advanced-configurations/plugins/bundles/bundle-cli

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

  • Clarified that subdirectories are not supported in the bundle-directory for plugin bundles.
  • Updated example directory structures for Golang, Javascript, and Python bundles to reflect the removal of subdirectories.
  • Added a success note to highlight the limitation regarding subdirectory usage in the bundle-directory.

Changes walkthrough 📝

Relevant files
Documentation
bundle-cli.md
Clarified subdirectory usage and updated examples in bundle
documentation

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

  • Updated the description to clarify that subdirectories are not
    supported in the bundle-directory.
  • Adjusted example directory structures for Golang, Javascript, and
    Python bundles to remove subdirectories.
  • Added a success note emphasizing the lack of subdirectory support.
    		•  +12/-9   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Documentation Clarity
    The note added at line 67 states that subdirectories are not supported in the bundle-directory. This is a significant change and should be reviewed for clarity and completeness to ensure users understand the implications.

    Consistency in Examples
    The examples for Golang, JavaScript, and Python bundles have been updated to remove subdirectories. Ensure the examples are consistent and accurately reflect the new structure.

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Fix grammatical error in the note for better readability

    Correct the grammar in the note to "Subdirectories are not supported in the
    bundle-directory" for clarity and accuracy.

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

    -Subdirectory are not supported in the `bundle-directory`
+Subdirectories are not supported in the `bundle-directory`
    Suggestion importance[1-10]: 7

    Why: The suggestion improves the grammatical accuracy and clarity of the note, enhancing the document's readability and professionalism. While it is a minor change, it contributes positively to the overall quality of the documentation.

    		7

    @netlify Netlify
    Copy link

    netlify bot commented Dec 18, 2024

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

    Name Link
    🔨 Latest commit 7eaf103
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/676281c9235ab200087a67f1
    😎 Deploy Preview https://deploy-preview-5831--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.

    @netlify Netlify
    Copy link

    netlify bot commented Dec 18, 2024 •
    edited
    Loading

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

    Name Link
    🔨 Latest commit 67cc61c
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67862175fd224c0008a7dae2
    😎 Deploy Preview https://deploy-preview-5831--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.

    OldStubbsy
    OldStubbsy requested changes Dec 24, 2024
    View reviewed changes
    Copy link

    @OldStubbsy OldStubbsy left a comment

    Choose a reason for hiding this comment

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

    Lines 61 and 62 made sense when the bundles where in subdirectories, they don't when they're not.

    Also their reference to Python doesn't make sense when the default in the docs is golang. I don't think a language needs to be mentioned, they're just "plugin source files"

    An example manifest to go with each example directory would make things much more clear. There's an example manifest at https://tyk.io/docs/plugins/how-to-serve-plugins/plugin-bundles/#manifest which could be used as a starting place

    sharadregoti and others added 2 commits January 8, 2025 10:46
    @sharadregoti @titpetric
    Update tyk-docs/content/product-stack/tyk-gateway/advanced-configurat…
    5a8b663 
    …ions/plugins/bundles/bundle-cli.md

Co-authored-by: Tit Petric <[email protected]>
    @sharadregoti @titpetric
    Update tyk-docs/content/product-stack/tyk-gateway/advanced-configurat…
    6b62502 
    …ions/plugins/bundles/bundle-cli.md

Co-authored-by: Tit Petric <[email protected]>
    OldStubbsy
    OldStubbsy approved these changes Jan 8, 2025
    View reviewed changes
    Copy link

    @OldStubbsy OldStubbsy left a comment

    Choose a reason for hiding this comment

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

    A huge improvement, thanks

    @sharadregoti sharadregoti merged commit f360640 into master Jan 14, 2025
    9 checks passed
    @sharadregoti sharadregoti deleted the TT-13731 branch January 14, 2025 08:36
    @sharadregoti
    Copy link
    Contributor Author

    /release to release-5.7

    @tykbot tykbot
    Copy link

    tykbot bot commented Jan 14, 2025

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jan 14, 2025
    @sharadregoti
    [TT-13731] Fixes bundle plugin sub-directory problem. (#5831)
    2d085cd 
    (cherry picked from commit f360640)
    @buger buger mentioned this pull request Jan 14, 2025
    Merged
    @sharadregoti
    Copy link
    Contributor Author

    /release to clone-master-before-major-ia-change

    @tykbot tykbot
    Copy link

    tykbot bot commented Jan 14, 2025

    @sharadregoti Succesfully merged PR

    @tykbot tykbot
    Copy link

    tykbot bot commented Jan 14, 2025

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jan 14, 2025
    @sharadregoti
    [TT-13731] Fixes bundle plugin sub-directory problem. (#5831)
    7f2e57d 
    (cherry picked from commit f360640)
    @buger buger mentioned this pull request Jan 14, 2025
    Merged
    @tykbot tykbot
    Copy link

    tykbot bot commented Jan 14, 2025

    @sharadregoti Seems like there is conflict and it require manual merge.

    buger added a commit that referenced this pull request Jan 14, 2025
    @buger
    Merging to release-5.7: [TT-13731] Fixes bundle plugin sub-directory …
    cb57b75 
    …problem. (#5831)

[TT-13731] Fixes bundle plugin sub-directory problem. (#5831)
    sharadregoti added a commit that referenced this pull request Jan 14, 2025
    @buger @sharadregoti
    Merging to clone-master-before-major-ia-change: [TT-13731] Fixes bund…
    36ea2db 
    …le plugin sub-directory problem. (#5831) (#5889)

[TT-13731] Fixes bundle plugin sub-directory problem. (#5831)


(cherry picked from commit f360640)

Co-authored-by: Master <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @OldStubbsy OldStubbsy OldStubbsy approved these changes

    @titpetric titpetric titpetric approved these changes

    @vverbani vverbani Awaiting requested review from vverbani

    Assignees
    No one assigned
    Labels
    Review effort [1-5]: 2
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @sharadregoti @titpetric @OldStubbsy