Skip to content

[TT-14489] Update documentation for master - Gateway 5.8.1 #6335

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

Merged
merged 27 commits into from
May 12, 2025

Conversation

buger
Copy link
Member

@buger buger commented Apr 23, 2025

User description

Triggered by: mativm02

Included:

Tyk Gateway: true
Tyk Dashboard: false
Tyk MDCB false
Tyk Pump false

Intended for: master
Changes sourced from: release-5.8.1
Config info generator branch: main

Note: Latest gateway 5.8.1 updates (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/TT-14489


PR Type

Documentation


Description

  • Clarified usage of ssl_certificates in Gateway config

  • Updated deprecation note for certificates option

  • Expanded explanation for certificate array values

  • Improved documentation for certificate configuration


Changes walkthrough 📝

Relevant files
Documentation
gateway-config.md
Clarify and expand SSL certificate configuration documentation

tyk-docs/content/shared/gateway-config.md

  • Updated deprecation note for certificates option
  • Clarified and expanded ssl_certificates usage description
  • Specified acceptable values for certificate array
  • Improved documentation clarity for SSL configuration
  • +5/-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.
  • 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

    Documentation Accuracy

    Ensure that the updated descriptions for ssl_certificates and the deprecation note for certificates accurately reflect the current implementation and intended usage in the Gateway, especially regarding certificate identification and file path requirements.

    Deprecated: Use `ssl_certificates`instead.
    
    ### http_server_options.ssl_certificates
    ENV: <b>TYK_GW_HTTPSERVEROPTIONS_SSLCERTIFICATES</b><br />
    Type: `[]string`<br />
    
    Index of certificates available to the Gateway for use in client and upstream communication.
    The string value in the array can be two of the following options:
    1. The ID assigned to and used to identify a certificate in the Tyk Certificate Store
    2. The path to a file accessible to the Gateway. This PEM file must contain the private key and public certificate pair concatenated together.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Apr 23, 2025

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

    Name Link
    🔨 Latest commit 75cac96
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/68219da13b08cd00083fb9e3
    😎 Deploy Preview https://deploy-preview-6335--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.

    @mativm02 mativm02 changed the title [TT-14489] Update documentation for master [TT-14489] Update documentation for master - Gateway 5.8.1 Apr 23, 2025
    @mativm02 mativm02 requested a review from sharadregoti April 24, 2025 10:24
    @ilijabojanovic ilijabojanovic enabled auto-merge (squash) May 12, 2025 06:47
    @ilijabojanovic ilijabojanovic merged commit a928334 into master May 12, 2025
    12 checks passed
    @ilijabojanovic ilijabojanovic deleted the update/TT-14489/release-master-docs branch May 12, 2025 07:08
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.8

    Copy link

    tykbot bot commented May 12, 2025

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

    tykbot bot pushed a commit that referenced this pull request May 12, 2025
    Import config/docs
    
    Co-authored-by: mativm02 <83959431+mativm02@users.noreply.github.com>
    (cherry picked from commit a928334)
    Copy link

    tykbot bot commented May 12, 2025

    @sharadregoti Created merge PRs

    buger added a commit that referenced this pull request May 12, 2025
    …Gateway 5.8.1 (#6335)
    
    [TT-14489] Update documentation for master - Gateway 5.8.1 (#6335)
    
    Import config/docs
    
    Co-authored-by: mativm02 <83959431+mativm02@users.noreply.github.com>
    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.

    4 participants