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.

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

Merging to release-5.5: [DX-1628] Updated for 5.4 (#5282) #5284

Merged

Conversation

buger
Copy link
Member

@buger buger commented Aug 20, 2024

User description

DX-1628 Updated for 5.4 (#5282)

Updated for 5.5


PR Type

Documentation


Description

  • Updated the OAS reference documentation to improve clarity and consistency in feature naming.
  • Added new features to the documentation, including "API segment tags", "Upstream load balancing", and a new "Traffic Logs" section.
  • Enhanced terminology for existing features, such as changing "IP Allowlist" to "IP access control" and "GW Request Signing" to "Client-GW request signing".

Changes walkthrough 📝

Relevant files
Documentation
oas-reference.md
Update and expand OAS reference documentation for clarity and new
features

tyk-docs/content/getting-started/using-oas-definitions/oas-reference.md

  • Updated feature names for consistency and clarity.
  • Added new features such as "API segment tags" and "Upstream load
    balancing".
  • Introduced a new section for "Traffic Logs" with detailed features.
  • Improved terminology for existing features like "IP access control"
    and "Client-GW request signing".
  • +55/-56 

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

    Updated for 5.5
    
    (cherry picked from commit 7c2d028)
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link
    Contributor

    github-actions bot commented Aug 20, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Standardize capitalization in table headers

    Ensure consistent capitalization in the table headers to maintain uniformity and
    improve readability. The header 'Api Designer' should be changed to 'API Designer'
    to match other occurrences and standard capitalization rules.

    tyk-docs/content/getting-started/using-oas-definitions/oas-reference.md [35-36]

    -| Feature                               | Implemented      | Api Designer  |
    +| Feature                               | Implemented      | API Designer  |
     |---------------------------------------|------------------|---------------|
     
    Suggestion importance[1-10]: 9

    Why: The suggestion correctly identifies an inconsistency in capitalization, which improves readability and maintains uniformity across the document.

    9
    Standardize feature name capitalization

    Correct the inconsistent capitalization in the feature names to maintain a
    professional and uniform appearance in the document. For example, 'Basic
    authentication' should be 'Basic Authentication'.

    tyk-docs/content/getting-started/using-oas-definitions/oas-reference.md [53]

    -| Basic authentication                  | ✅               | ✅            |
    +| Basic Authentication                  | ✅               | ✅            |
     
    Suggestion importance[1-10]: 9

    Why: The suggestion improves the document's professionalism and uniformity by correcting inconsistent capitalization in feature names.

    9
    Standardize the use of special characters for consistency

    Correct the inconsistent use of special characters for the 'not implemented' symbol.
    Replace '❌️' with '❌' to maintain consistency across the document.

    tyk-docs/content/getting-started/using-oas-definitions/oas-reference.md [39-40]

    -| Upstream load balancing               | ❌️               | ❌️            |
    -| Uptime tests                          | ❌️               | ❌️            |
    +| Upstream load balancing               | ❌               | ❌            |
    +| Uptime tests                          | ❌               | ❌            |
     
    Suggestion importance[1-10]: 8

    Why: The suggestion addresses a minor but valid issue of inconsistent use of special characters, which enhances the document's consistency.

    8
    Enhancement
    Clarify the feature name for better understanding

    Update the feature name 'IP access control' to 'IP Allowlist/Blocklist' for clarity
    and to reflect a more specific functionality, aligning with the previously used
    terms in the old hunk.

    tyk-docs/content/getting-started/using-oas-definitions/oas-reference.md [56]

    -| IP access control                     | ❌️               | ❌️            |
    +| IP Allowlist/Blocklist                | ❌               | ❌            |
     
    Suggestion importance[1-10]: 7

    Why: The suggestion improves clarity by aligning the feature name with previously used terms, although it is not crucial, it enhances understanding.

    7

    Copy link

    netlify bot commented Aug 20, 2024

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

    Name Link
    🔨 Latest commit ce59a5d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/66c49b526938410008337661
    😎 Deploy Preview https://deploy-preview-5284--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.

    @buger buger merged commit f1ed7d1 into release-5.5 Aug 20, 2024
    9 checks passed
    @buger buger deleted the merge/release-5.5/7c2d02894809da8caab7f63a35735593ee446b47 branch August 20, 2024 13:36
    @dcs3spp dcs3spp changed the title Merging to release-5.5: [DX-1624] Updated for 5.4 (#5282) Merging to release-5.5: [DX-1628] Updated for 5.4 (#5282) Aug 20, 2024
    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