Skip to content

🔄 Preview: [TT-17927-x2] Update documentation for master - #2803

Draft
probelabs[bot] wants to merge 557 commits into
productionfrom
update/TT-17927-x2/release-main-docs
Draft

🔄 Preview: [TT-17927-x2] Update documentation for master#2803
probelabs[bot] wants to merge 557 commits into
productionfrom
update/TT-17927-x2/release-main-docs

Conversation

@probelabs

@probelabs probelabs Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

🔗 Auto-generated mirror PR for Mintlify preview

Original PR: #2802
Author: @probelabs[bot]

Purpose

This PR provides a Mintlify preview link for reviewing documentation changes.

Preview Link

The Mintlify preview will be available once this PR is processed.

⚠️ Important Notes

Changes

Triggered by: jay-deshmukh

Included:

Tyk Gateway: true
Tyk Dashboard: true
Tyk MDCB true
Tyk Pump true
Tyk Portal: true
Tyk Operator CRD: false
Tyk AI Studio: false

Intended for: master
Portal release: master
AI Studio release: main
Pump release: master
MDCB release: master
Changes sourced from: release-5.13.2
Config info generator branch: main

Note: (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/TT-17927-x2

probelabs Bot and others added 30 commits April 10, 2026 22:36
…chor fragments (#1865)

* DX-2361: Add GitHub Actions to validate external URLs and internal anchors

- Extend validate_mintlify_docs.py with --check-anchors flag that extracts
  GFM-slugified heading anchors, {#custom-id} syntax, and <a id/name> elements
  from target MDX files and verifies every internal #fragment resolves
- Update validate-docs.yml to run anchor check on every PR
- Add check-external-links.yml workflow: weekly scheduled (Mon 07:00 UTC) and
  manual-trigger run that HEAD-checks all external HTTP/HTTPS URLs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* DX-2361: Run external link check on every pull request

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* DX-2361: Fix exit code not failing on broken external links

External link failures were reported but never factored into the
exit code, so CI was passing despite 404s. Added has_broken_external
check and a summary line for external link results.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* DX-2361: Switch external link checker to lychee

Replace sequential Python/requests approach with lycheeverse/lychee-action.
Lychee runs checks in parallel, has built-in retry logic, and is purpose-built
for link checking — much faster on a repo with 1500+ external URLs.

Add lychee.toml to exclude tyk-owned domains, localhost, placeholder URLs,
and sites known to block bots (LinkedIn, Facebook). Accept 429 as non-broken
to handle rate-limited responses gracefully.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix mirror-pr workflow failing on PR bodies with special characters

GitHub Actions expands ${{ }} expressions before the shell runs, so
backticks and $ signs in PR bodies were injected raw into the script
and interpreted as shell command substitution.

Fix: write static content via a single-quoted heredoc (no shell
expansion), then append the PR body via printf with an env var
($PR_BODY). Shell variables accessed as "$VAR" are never
re-interpreted, making any PR body content safe.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix lychee checking internal/relative links

Add scheme = ["https", "http"] to lychee.toml so lychee only attempts
to check http/https URLs. Without this, lychee tries to resolve
root-relative paths (/img/..., /page/...) as file URIs and fails.
Internal links are already validated by validate-docs.yml.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix lychee erroring on root-relative paths

scheme = ["https", "http"] didn't help because lychee fails to build
the URL before the scheme filter runs. Set base = "https://tyk.io" so
root-relative paths (/img/..., /page/...) are resolved to
https://tyk.io/... and then silently skipped by the existing tyk.io
exclude rule, rather than producing "cannot convert path to URI" errors.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix lychee config: base -> base_url

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
#1872)

* docs: add container support guide (Podman, containerd, CRI-O)

* docs(DX-2363): restructure container runtimes guide and add cross-references

- Rewrite containers.mdx as a proper Tyk docs page: clean frontmatter,
  active voice, no numbered headings, FAQ as AccordionGroup, no em dashes
- Move page from tyk-self-managed/install/containers to
  deployment-and-operations/container-runtimes
- Update docs.json: remove old nav entry, add new entry under Configuration
  group after planning-for-production
- Add Container Runtimes cross-reference Note (after Prerequisites) to 7
  install pages: tyk-self-managed docker/k8s, portal docker/k8s,
  ai-studio docker/k8s, tyk-governance installation

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: Sharad Regoti <sharadregoti15@gmail.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Update dashboard.mdx
Replace ORG_GH_TOKEN with GitHub App token (actions/create-github-app-token)
in release-bot.yaml, autoupdate.yaml, mirror-pr-to-build-deploy.yml,
trigger-docs-deploy.yml, and deploy-docs.yml workflows.
* Update gateway.mdx

* Update overview.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update dashboard.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/dashboard.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update dashboard.mdx

* Update gateway.mdx

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>
Co-authored-by: probelabs[bot] <219682034+probelabs[bot]@users.noreply.github.com>
…1905)

[TT-17030] Migrate release-to-branches-with-label.yml from PAT to GitHub App token

Replace ORG_GH_TOKEN (PAT) with GitHub App token generated via
actions/create-github-app-token in the run-on-pr-merged job.

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: probelabs[bot] <219682034+probelabs[bot]@users.noreply.github.com>
* Update mdcb.mdx

* Update overview.mdx

* Update mdcb.mdx

* Update mdcb.mdx

* Update mdcb.mdx

* Update mdcb.mdx

* Apply suggestions from code review

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Master <sharadregoti15@gmail.com>

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: probelabs[bot] <219682034+probelabs[bot]@users.noreply.github.com>
Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>
Co-authored-by: Master <sharadregoti15@gmail.com>
* docs: Add release notes for Portal v1.17.1

* Update portal.mdx

* Update overview.mdx

* Update portal.mdx

* Update portal.mdx

* Update portal.mdx

* Update portal.mdx

* Update portal.mdx

* Update portal.mdx

* Update portal.mdx

* Update portal.mdx

* Update portal.mdx

* Apply suggestions from code review

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Master <sharadregoti15@gmail.com>

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com>
Co-authored-by: probelabs[bot] <219682034+probelabs[bot]@users.noreply.github.com>
Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>
Co-authored-by: Master <sharadregoti15@gmail.com>
@mintlify

mintlify Bot commented Aug 25, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tyk 🟢 Ready View Preview Aug 25, 2026, 11:41 AM

JoanCamosTyk and others added 4 commits August 26, 2026 16:12
* Update gateway.mdx

* Update dashboard.mdx

* Update overview.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update developer-support/release-notes/dashboard.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/dashboard.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/dashboard.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/dashboard.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/dashboard.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update developer-support/release-notes/gateway.mdx

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Apply suggestion from @andyo-tyk

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Apply suggestion from @andyo-tyk

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update gateway.mdx

* Update gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Update gateway.mdx

* F

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

---------

Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>
Co-authored-by: Sharad Regoti <sharadregoti15@gmail.com>
Co-authored-by: probelabs[bot] <219682034+probelabs[bot]@users.noreply.github.com>
Cherry-pick conflicts for b73189c

Co-authored-by: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com>
@probelabs probelabs Bot closed this Aug 27, 2026
@jay-deshmukh jay-deshmukh reopened this Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.