search

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.5: remove publish time (#5404) #5405

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
Configuration changes
config.toml
Modify lastmod array in config.toml                                           
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 from Kubernetes on Windows doc               
    tyk-docs/content/tyk-on-prem/kubernetes-on-windows.md - Removed the `publishdate` front matter entry.
    		+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

    Incorrect Update
    The PR description states that `publishDate` was removed from the `lastmod` array, but the diff shows it was added instead. This contradicts the intended changes.
    github-actions[bot] commented 1 month ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Reorder the elements in the lastmod array to maintain logical consistency and processing priority ___ **Consider reordering the elements in the lastmod array to maintain consistency with
    the previous order, prioritizing 'lastmod' and 'date' at the beginning and end
    respectively, to ensure that the most relevant timestamps are considered first and
    last in the processing order.** [tyk-docs/config.toml [40]](https://github.com/TykTechnologies/tyk-docs/pull/5405/files#diff-b5607885ca99f865246defbac60f7998022af1e5da2cba05d27eac99e12a15faR40-R40) ```diff -lastmod = ["lastmod", "publishDate", ":git",':fileModTime', "date"] +lastmod = ["lastmod", ":git",':fileModTime', "publishDate", "date"] ```
    Suggestion importance[1-10]: 8 Why: The suggestion improves maintainability by restoring the original order of elements in the `lastmod` array, which may be important for consistent processing of timestamps. This change addresses a potential oversight in the PR and enhances logical consistency.
    		8
    netlify[bot] commented 1 month ago

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

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