TykTechnologies / tyk-docs

Docs for Tyk Open source API gateway and API management platform. 100% Cloud native
https://tyk.io/docs/apim/open-source/installation/
Other
67 stars 152 forks source link

Merging to release-5.4: remove publish time (#5404) #5406

Closed buger closed 1 month ago

buger commented 1 month ago

User description

remove publish time (#5404)


PR Type

enhancement, documentation


Description


Changes walkthrough ๐Ÿ“

Relevant files
Enhancement
config.toml
Modify lastmod array to remove publishDate                             

tyk-docs/config.toml
  • Removed publishDate from the lastmod array.
  • Adjusted the order of elements in the lastmod array.
  • +1/-1     
    Documentation
    kubernetes-on-windows.md
    Remove publishdate metadata from Kubernetes on Windows doc

    tyk-docs/content/tyk-on-prem/kubernetes-on-windows.md - Removed `publishdate` metadata from the document.
    +0/-1     

    ๐Ÿ’ก PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    github-actions[bot] commented 1 month ago

    PR Reviewer Guide ๐Ÿ”

    โฑ๏ธ Estimated effort to review: 1 ๐Ÿ”ตโšชโšชโšชโšช
    ๐Ÿงช No relevant tests
    ๐Ÿ”’ No security concerns identified
    โšก Key issues to review

    Configuration Error
    The line intended to remove 'publishDate' from the 'lastmod' array actually re-adds it. This contradicts the PR's description and goal.
    github-actions[bot] commented 1 month ago

    PR Code Suggestions โœจ

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Maintain a consistent order in the lastmod array for predictability and readability ___ **It's recommended to maintain a consistent order for elements in the lastmod array to
    ensure predictable behavior and readability. The new order introduces publishDate at
    a different position compared to its previous one. Consider reverting to the
    original order or choosing a new order that reflects the priority of date sources
    more clearly.** [tyk-docs/config.toml [40]](https://github.com/TykTechnologies/tyk-docs/pull/5406/files#diff-b5607885ca99f865246defbac60f7998022af1e5da2cba05d27eac99e12a15faR40-R40) ```diff -lastmod = ["lastmod", "publishDate", ":git",':fileModTime', "date"] +lastmod = ["lastmod", ":git",':fileModTime', "date", "publishDate"] ```
    Suggestion importance[1-10]: 8 Why: The suggestion addresses a maintainability issue by recommending a consistent order for elements in the `lastmod` array, which can improve readability and predictability. This is a valid and useful suggestion for maintaining code quality.
    8
    netlify[bot] commented 1 month ago

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

    Name Link
    Latest commit f4220f5efa8cf34465cdfa1bf81489a69f6fd18d
    Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/66e45bf1967b8f0007b37b17
    Deploy Preview https://deploy-preview-5406--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[bot] commented 1 month ago

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

    Name Link
    Latest commit f4220f5efa8cf34465cdfa1bf81489a69f6fd18d
    Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/66e45bf1967b8f0007b37b17
    Deploy Preview https://deploy-preview-5406--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.