🤖 Auto-merge documentation from branches

[buger]

User description

📚 Documentation Merge Summary

This PR contains automatically merged documentation from multiple branches.

Triggered by:

• Branch: release-5.8
• Commit: 825ec5a
• PR: Merging to release-5.8: Updated branch config (#661) #664 - Merging to release-5.8: Updated branch config (Updated branch config #661) (cherry-pick of Updated branch config #661)

Deployment Details:

• Generated from: branches-config.json
• Run ID: 17032741950
• Subfolder: (root deployment)
• Timestamp: $(date)

Changes Include:

• ✅ Merged documentation from multiple branches
• ✅ Generated unified docs.json configuration
• ✅ Updated assets and content structure
• ✅ Cleaned up outdated version folders

---

🚦 This PR will be processed by merge queue to ensure proper validation and ordering.

Previous deployment PRs have been automatically closed to prevent conflicts.

---

PR Type

Enhancement, Documentation

---

Description

• Add v5.9 vendor extension docs snippet

• Update 5.8 JS plugin links and examples

• Add 5.8 portal API front matter

• Add Google site verification file

---

Diagram Walkthrough

flowchart LR
  A["snippets/5.9/x-tyk-gateway.mdx"] -- "new reference content" --> D["Docs build"]
  B["5.8/api-management/plugins/javascript.mdx"] -- "fix links & examples" --> D
  C["5.8/product-stack/.../tyk-edp-api.mdx"] -- "add front matter" --> D
  E["5.8/google407269a3a12bf5e5.html"] -- "site verification" --> D

Loading

File Walkthrough

	Relevant files
Documentation	15 files google407269a3a12bf5e5.html Add Google site verification content                                          [link]    javascript.mdx Fix versioned links and code sample fields                              +28/-27  tyk-edp-api.mdx Add front matter metadata for page                                              [link]    gateway.mdx Add or update 5.8 gateway release notes                                    +5104/-0 dashboard.mdx Add or update 5.8 dashboard release notes                                +4304/-0 operator.mdx Add operator automation documentation                                        +5053/-0 rich-plugins.mdx Add rich plugins guide for 5.8                                                      +3519/-0 install.mdx Add self-managed installation docs                                              +3141/-0 tyk-cloud.mdx Add Tyk Cloud overview for 5.8                                                      +2795/-0 graphql.mdx Add GraphQL management docs                                                            +2469/-0 tyk-pump.mdx Add Tyk Pump docs for 5.8                                                                +1835/-0 logs-metrics.mdx Add logging and metrics guidance                                                  +1662/-0 overview.mdx Add plugins overview content                                                          +1192/-0 mdcb.mdx Add MDCB documentation for 5.8                                                      +984/-0  portal-keys.mdx Add portal keys API docs                                                                  +1633/-0
Enhancement	4 files x-tyk-gateway.mdx Add comprehensive x-tyk-api-gateway reference                        +3019/-0 pump-config.mdx Add v5.9 pump configuration snippet                                            +5100/-0 gateway-config.mdx Add v5.9 gateway config snippet                                                    +2201/-0 dashboard-config.mdx Add v5.9 dashboard config snippet                                                +1379/-0
Configuration changes	1 files docs.json Update docs registry for new/changed pages                              +8528/-12959
Additional files	101 files advanced-configuration.mdx +0/-14    demo-virtual-endpoint.mdx +0/-299  virtual-endpoints.mdx +0/-69    error-templates.mdx +0/-35    integrate.mdx +0/-13    3rd-party-identity-providers.mdx +0/-24    custom.mdx +0/-50    dashboard-login-ldap-tib.mdx +0/-294  ldap.mdx +0/-170  social.mdx +0/-21    app-login-with-gplus.mdx +0/-80    dashboard-login-with-gplus.mdx +0/-45    api-auth-mode.mdx +0/-7      sso.mdx +0/-168  manage-multiple-environments.mdx +0/-50    move-apis-between-environments.mdx +0/-61    move-keys-between-environments.mdx +0/-15    move-policies-between-environments.mdx +0/-145  with-tyk-cloud-classic.mdx +0/-8      with-tyk-multi-cloud.mdx +0/-62    with-tyk-on-premises.mdx +0/-78    other-protocols.mdx +0/-7      transform-traffic.mdx +0/-101  endpoint-designer.mdx +0/-97    jq-transformations.mdx +0/-65    looping.mdx +0/-102  request-method-transform.mdx +0/-41    response-body.mdx +0/-86    response-headers.mdx +0/-64    soap-rest.mdx +0/-183  websockets.mdx +0/-54    overview.mdx +0/-21    advanced-use-cases.mdx +0/-188  use-cases.mdx +0/-45    authentication-authorization.mdx +0/-2757 automations.mdx +0/-4563 api-observability.mdx +0/-63    deploy-apis-overview.mdx +0/-57    tyk-oas-middleware.mdx +0/-419  gateway-api.mdx +0/-7      security-best-practices.mdx +0/-395  apim.mdx +0/-48    open-source.mdx +0/-28    installation.mdx +0/-77    basic-config-and-security.mdx +0/-15    control-limit-traffic.mdx +0/-11    key-expiry.mdx +0/-35    rate-limiting.mdx +0/-147  request-quotas.mdx +0/-62    request-size-limits.mdx +0/-70    request-throttling.mdx +0/-42    reduce-latency.mdx +0/-10    caching.mdx +0/-78    advanced-cache.mdx +0/-47    global-cache.mdx +0/-76    invalidate-cache.mdx +0/-32    optimise-cache.mdx +0/-50    upstream-controlled-cache.mdx +0/-65    report-monitor-trigger-events.mdx +0/-56    custom-handlers-javascript.mdx +0/-107  event-data.mdx +0/-29    event-types.mdx +0/-46    instrumentation.mdx +0/-47    monitors.mdx +0/-100  webhooks.mdx +0/-115  ext-oauth-middleware.mdx +0/-244  dashboard.mdx +0/-8      create-user-groups.mdx +0/-76    create-users.mdx +0/-126  dashboard-admin-api.mdx +0/-17    organisations.mdx +0/-36    search-users.mdx +0/-11    user-roles.mdx +0/-57    gateway.mdx +0/-13    key-hashing.mdx +0/-60    key-level-security.mdx +0/-90    password-policy.mdx +0/-41    security-policies.mdx +0/-12    partitioned-policies.mdx +0/-356  policies-guide.mdx +0/-152  tls-and-ssl.mdx +0/-373  middleware-execution-order.mdx +0/-9      outbound-email-configuration.mdx +0/-150  context-variables.mdx +0/-109  contribute.mdx +0/-22    dashboard-admin-api.mdx +0/-6      organisations.mdx +0/-268  debugging-series.mdx +0/-10    mongodb-debugging.mdx +0/-107  quick-start.mdx +0/-171  quick-start.mdx +0/-59    consul.mdx +0/-81    vault.mdx +0/-111  tyk-helm-tyk-stack-mongodb.mdx +0/-138  tyk-helm-tyk-stack-postgresql.mdx +0/-112  overview.mdx +0/-22    backup-apis-and-policies.mdx +0/-33    debugging-selfmanaged.mdx +0/-184  inclusive-naming.mdx +0/-122  how-to-reduce-cpu-usage-in-a-redis-cluster.mdx +0/-56    Additional files not shown

---

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Fix invalid frontmatter key MDX frontmatter uses YAML where keys should not be quoted with single quotes containing a colon. This line can break frontmatter parsing and SEO metadata. Use a valid key name like description or quote the key properly without conflicting characters. 5.8/developer-support/release-notes/gateway.mdx [3] -'og:description': "Release notes documenting updates, enhancements, and changes for Tyk Gateway." +description: "Release notes documenting updates, enhancements, and changes for Tyk Gateway." Suggestion importance[1-10]: 7 __ Why: The key 'og:description' in YAML frontmatter is unusual and may not be parsed by the site tooling; replacing with description is safer and likely intended. Impact is moderate correctness/SEO, and the proposed change matches the snippet.	Medium
	Fix malformed frontmatter key The frontmatter key uses quotes around the key, which may break MDX/Docs parsers expecting plain YAML keys. Use an unquoted key (e.g., og:description) to ensure consistent metadata parsing. 5.8/developer-support/release-notes/dashboard.mdx [3] -'og:description': "Release notes documenting updates, enhancements, and changes for Tyk Dashboard." +og:description: "Release notes documenting updates, enhancements, and changes for Tyk Dashboard." Suggestion importance[1-10]: 7 __ Why: The frontmatter key is quoted as 'og:description', which is non-standard in YAML frontmatter and can cause parsing issues; switching to og:description is a reasonable, low-risk improvement.	Medium
	Fix Google verification content Serve the Google verification file with the exact token content, not the filename. Replace with the token string provided by Google (typically starts with "google-site-verification: " followed by a long token) or the HTML meta tag variant if required. This mismatch will cause verification to fail. 5.8/google407269a3a12bf5e5.html [1] -google-site-verification: google407269a3a12bf5e5.html +google-site-verification: google407269a3a12bf5e5 Suggestion importance[1-10]: 5 __ Why: The existing code matches the new hunk and the advice to ensure correct token content is valid, but the improved_code alters the string by removing ".html", which may be incorrect depending on Google's required content; impact is moderate but not definitively correct.	Low
General	Fix malformed list/code block Extra leading list marker produces a nested empty list and may break code block rendering. Use a single list item with the fenced code block directly beneath to ensure proper formatting. 5.8/developer-support/release-notes/gateway.mdx [64-66] -- - ```bash -- docker pull tykio/tyk-gateway:v5.8.2 -- ``` +- ```bash + docker pull tykio/tyk-gateway:v5.8.2 + ``` Suggestion importance[1-10]: 6 __ Why: The extra nested list marker before the fenced code block can break rendering; simplifying to a single list item improves formatting. This is a minor but valid fix to presentation.	Low
	Prevent broken docs navigation Ensure every listed page path actually exists for the new version and matches prior structure. In particular, verify renamed/moved pages like "other-protocols", "grpc-proxy", "sse-proxy", and the relocation of "mdcb" to Deploy section; broken paths will 404 in navigation. docs.json [1141-1386] { "version": "v5.8", "tabs": [ { "tab": "Home", "groups": [ { "group": "Documentation", "pages": [ "5.8/index" ] } ] }, ... { "group": "Advanced Protocols", "pages": [ - "5.8/advanced-configuration/other-protocols", + "5.8/key-concepts/other-protocols", "5.8/key-concepts/tcp-proxy", "5.8/key-concepts/grpc-proxy", "5.8/advanced-configuration/sse-proxy", "5.8/advanced-configuration/websockets" ] }, ... - "5.8/api-management/mdcb" + { + "group": "Deploy Tyk", + "pages": [ + ... + "5.8/api-management/mdcb" + ] + } ] } Suggestion importance[1-10]: 3 __ Why: The suggestion is a general verification request and includes ellipses and path changes not evidenced by the diff; while ensuring paths exist is reasonable, the improved_code is speculative and not directly derived from the PR changes.	Low
	Normalize table formatting The table contains double spaces within cells which can render oddly in MDX markdown tables. Normalize spacing to single spaces to ensure correct table rendering across docs tooling. Avoid trailing spaces at line ends. 5.8/developer-support/release-notes/gateway.mdx [46-51] -| Third Party Dependency | Tested Versions | Compatible Versions | Comments | -| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | -| [Go](https://go.dev/dl/) | 1.23 | 1.23 | [Go plugins](/5.8/api-management/plugins/golang) must be built using Go 1.23 | +| Third Party Dependency | Tested Versions | Compatible Versions | Comments | +| :--------------------- | :-------------- | :------------------ | :-------- | +| [Go](https://go.dev/dl/) | 1.23 | 1.23 | [Go plugins](/5.8/api-management/plugins/golang) must be built using Go 1.23 | Suggestion importance[1-10]: 3 __ Why: Reducing spacing in markdown tables is stylistic; most MDX renderers handle extra spaces fine. It's low impact, though harmless; the improved code alters alignment but not semantics.	Low
	Align anchor ids and heading levels The anchor link earlier references /5.8/#Changelog-v5.8.1, but the in-page heading uses "Changelog" with capital C; many static site generators create ids from the visible text, not the id attribute when mixing Markdown headers. Ensure the id matches and avoid duplicate heading semantics by using a single consistent heading. 5.8/developer-support/release-notes/dashboard.mdx [130-131] -<h4 id="Changelog-v5.8.1">Changelog</h4> -##### Fixed +<h4 id="changelog-v5.8.1">Changelog</h4> +#### Fixed Suggestion importance[1-10]: 3 __ Why: The existing code already sets an explicit id attribute (Changelog-v5.8.1), so the link should work; changing case and heading level may be unnecessary and could be stylistically inconsistent.	Low
	Fix broken internal anchor slug The internal link anchor mixes numeric-only fragment #300-release-notes which some MDX slug generators normalize (e.g., to #3-0-0-release-notes). Update the fragment to the actual generated id to avoid broken navigation. 5.8/developer-support/release-notes/dashboard.mdx [128-129] - Helm charts - - [tyk-charts v3.0.0](/5.8/developer-support/release-notes/helm-chart#300-release-notes) + - [tyk-charts v3.0.0](/5.8/developer-support/release-notes/helm-chart#3-0-0-release-notes) Suggestion importance[1-10]: 2 __ Why: The proposed fragment change is speculative without evidence of the target page’s generated slug; altering it may break a correct link, so impact is low and uncertain.	Low

[buger]

🤖 Superseded by newer deployment (Run #279)