New IA - Migration to Tyk #5727

DavidRollins · 2024-11-16T05:19:03Z

User description

For internal users - Please add a Jira DX PR ticket to the subject!

Preview Link

Description

Screenshots (if appropriate)

Checklist

I have added a preview link to the PR description.
I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
I have reviewed the guidelines for contributing to this repository.
I have read the technical guidelines for contributing to this repository.
Make sure you have started your change off our latest master.
I labeled the PR

PR Type

enhancement, documentation

Description

Introduced a new "Migration To Tyk" section in the documentation, updating various links across multiple files to point to this new section.
Enhanced the menu structure by adding a new entry for "Migration To Tyk" and removing outdated entries.
Added alias mappings to redirect old documentation paths to the new "Migration To Tyk" section.
Updated release notes and other documentation files to ensure consistency with the new migration section.

Changes walkthrough 📝

Relevant files

Enhancement

1 files

menu.yaml `Update menu structure to include migration and remove redundancies` tyk-docs/data/menu.yaml Added a new menu entry for "Migration To Tyk". Removed multiple redundant or outdated menu entries. Updated visibility settings for several menu items.	+40/-587

Documentation

10 files

version-5.3.md `Update release notes with migration links` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.3.md Updated links to point to the new "Migration To Tyk" section. Adjusted references for database management and plugin usage.	+21/-21
version-5.3.md `Update gateway release notes with migration links` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md Updated Go plugin links to reference the "Migration To Tyk" section.	+10/-10
apim.md `Update APIM references to migration section` tyk-docs/content/apim.md Updated references to point to the new "Migration To Tyk" section.	+4/-4
version-5.5.md `Update dashboard release notes with migration links` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.5.md Updated Go plugin links to reference the "Migration To Tyk" section.	+3/-3
api-definition.md `Update operator API definition links to migration section` tyk-docs/content/product-stack/tyk-operator/reference/api-definition.md Updated links for load balancing and circuit breaker to the "Migration To Tyk" section.	+3/-3
owasp-top-ten.md `Update OWASP security links to migration section` tyk-docs/content/basic-config-and-security/security/owasp-top-ten.md Updated security feature links to point to the "Migration To Tyk" section.	+4/-4
tyk-oss-chart.md `Update OSS chart documentation with migration links` tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md Updated quick start and Redis configuration links to the "Migration To Tyk" section.	+5/-5
version-5.5.md `Update gateway release notes with migration links` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.5.md Updated Go plugin links to reference the "Migration To Tyk" section.	+3/-3
tyk-data-plane-chart.md `Update data plane chart documentation with migration links` tyk-docs/content/product-stack/tyk-charts/tyk-data-plane-chart.md Updated hybrid gateway deployment and Redis configuration links to the "Migration To Tyk" section.	+5/-5
tyk-stack-chart.md `Update stack chart documentation with migration links` tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md Updated quick start and Redis configuration links to the "Migration To Tyk" section.	+4/-4

Configuration changes

1 files

alias.json `Add alias mappings for migration paths` tyk-docs/data/alias.json Added numerous alias mappings to redirect old paths to the new "Migration To Tyk" section.	+157/-2

Additional files (token-limit)

95 files

migration-to-tyk.md `...` tyk-docs/content/migration-to-tyk.md ...	+11348/-1
resource-consumption.md `...` tyk-docs/content/apim-best-practice/api-security-best-practice/resource-consumption.md ...	+2/-2
version-1.3.md `...` tyk-docs/content/product-stack/tyk-charts/release-notes/version-1.3.md ...	+3/-3
docker-pro-demo.md `...` tyk-docs/content/tyk-on-premises/docker/docker-pro-demo.md ...	+3/-3
CONTRIBUTING-TECHNICAL-GUIDE.md `...` CONTRIBUTING-TECHNICAL-GUIDE.md ...	+6/-6
version-3.0.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-3.0.md ...	+4/-4
overview.md `...` tyk-docs/content/product-stack/tyk-charts/overview.md ...	+5/-5
version-5.6.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.6.md ...	+2/-2
version-2.7.md `...` tyk-docs/content/product-stack/tyk-enterprise-mdcb/release-notes/version-2.7.md ...	+3/-3
tyk-control-plane-chart.md `...` tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md ...	+3/-3
how-to-reduce-cpu-usage-in-a-redis-cluster.md `...` tyk-docs/content/developer-support/frequently-asked-questions/how-to-reduce-cpu-usage-in-a-redis-cluster.md ...	+1/-1
version-5.6.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md ...	+2/-2
url-rewrite-middleware.md `...` tyk-docs/content/product-stack/tyk-gateway/middleware/url-rewrite-middleware.md ...	+3/-3
install.md `...` tyk-docs/content/tyk-self-managed/install.md ...	+5/-5
version-4.0.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-4.0.md ...	+3/-3
transform-traffic.md `...` tyk-docs/content/advanced-configuration/transform-traffic.md ...	+2/-2
version-1.6.md `...` tyk-docs/content/product-stack/tyk-charts/release-notes/version-1.6.md ...	+2/-2
version-5.2.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.2.md ...	+2/-2
version-5.1.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.1.md ...	+1/-1
upgrade-go-plugin.md `...` tyk-docs/content/developer-support/upgrading-tyk/deployment-model/cloud/upgrade-go-plugin.md ...	+2/-2
client-authentication.md `...` tyk-docs/content/product-stack/tyk-operator/advanced-configurations/client-authentication.md ...	+2/-2
version-5.1.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.1.md ...	+1/-1
installing-tyk-operator.md `...` tyk-docs/content/tyk-stack/tyk-operator/installing-tyk-operator.md ...	+2/-2
installation.md `...` tyk-docs/content/apim/open-source/installation.md ...	+3/-3
getting-started.md `...` tyk-docs/content/tyk-cloud/getting-started.md ...	+2/-2
version-4.3.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-4.3.md ...	+2/-2
version-4.3.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-4.3.md ...	+2/-2
create-api.md `...` tyk-docs/content/getting-started/create-api.md ...	+1/-1
version-3.0.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-3.0.md ...	+2/-2
database-options.md `...` tyk-docs/content/tyk-dashboard/database-options.md ...	+4/-4
version-5.4.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.4.md ...	+1/-1
create-api-include.md `...` tyk-docs/content/shared/create-api-include.md ...	+1/-1
version-5.4.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.4.md ...	+1/-1
response-body.md `...` tyk-docs/content/advanced-configuration/transform-traffic/response-body.md ...	+1/-1
request-body.md `...` tyk-docs/content/transform-traffic/request-body.md ...	+1/-1
tyk-oas-api-definition.md `...` tyk-docs/content/product-stack/tyk-operator/reference/tyk-oas-api-definition.md ...	+1/-1
setup-prometheus-pump.md `...` tyk-docs/content/product-stack/tyk-pump/advanced-configurations/setup-prometheus-pump.md ...	+2/-2
version-2.9.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/archived-releases/version-2.9.md ...	+2/-2
version-2.9.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/archived-releases/version-2.9.md ...	+2/-2
version-5.0.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.0.md ...	+1/-1
docker-pro-wsl.md `...` tyk-docs/content/tyk-on-premises/docker/docker-pro-demo/docker-pro-wsl.md ...	+1/-1
cloud.md `...` tyk-docs/content/developer-support/release-notes/cloud.md ...	+1/-1
mongodb-debugging.md `...` tyk-docs/content/debugging-series/mongodb-debugging.md ...	+2/-2
api-definition-objects.md `...` tyk-docs/content/tyk-gateway-api/api-definition-objects.md ...	+1/-1
upgrade-cloud-saas.md `...` tyk-docs/content/developer-support/upgrading-tyk/deployment-model/cloud/upgrade-cloud-saas.md ...	+2/-2
version-1.5.md `...` tyk-docs/content/product-stack/tyk-charts/release-notes/version-1.5.md ...	+1/-1
version-1.4.md `...` tyk-docs/content/product-stack/tyk-charts/release-notes/version-1.4.md ...	+1/-1
supported-languages.md `...` tyk-docs/content/plugins/supported-languages.md ...	+1/-1
datadog.md `...` tyk-docs/content/tyk-configuration-reference/tyk-pump-configuration/datadog.md ...	+1/-1
plugins.md `...` tyk-docs/content/plugins.md ...	+1/-1
response-headers.md `...` tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md ...	+1/-1
request-headers.md `...` tyk-docs/content/transform-traffic/request-headers.md ...	+1/-1
pump-1.10.md `...` tyk-docs/content/product-stack/tyk-pump/release-notes/pump-1.10.md ...	+1/-1
pump-1.11.md `...` tyk-docs/content/product-stack/tyk-pump/release-notes/pump-1.11.md ...	+1/-1
debugging-selfmanaged.md `...` tyk-docs/content/developer-support/debugging-series/debugging-selfmanaged.md ...	+1/-1
gateway-config.md `...` tyk-docs/content/shared/gateway-config.md ...	+2/-2
endpoint-designer.md `...` tyk-docs/content/advanced-configuration/transform-traffic/endpoint-designer.md ...	+1/-1
moesif.md `...` tyk-docs/content/tyk-configuration-reference/tyk-pump-configuration/moesif.md ...	+1/-1
mdcb-example-minimising-latency.md `...` tyk-docs/content/tyk-multi-data-centre/mdcb-example-minimising-latency.md ...	+1/-1
version-2.5.md `...` tyk-docs/content/product-stack/tyk-enterprise-mdcb/release-notes/version-2.5.md ...	+1/-1
installation.md `...` tyk-docs/content/getting-started/installation.md ...	+2/-2
manage-multiple-environments.md `...` tyk-docs/content/advanced-configuration/manage-multiple-environments.md ...	+1/-1
organisations.md `...` tyk-docs/content/basic-config-and-security/security/dashboard/organisations.md ...	+1/-1
version-2.0.md `...` tyk-docs/content/product-stack/tyk-charts/release-notes/version-2.0.md ...	+1/-1
enable-sso.md `...` tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/enable-sso.md ...	+1/-1
with-tyk-multi-cloud.md `...` tyk-docs/content/advanced-configuration/manage-multiple-environments/with-tyk-multi-cloud.md ...	+1/-1
event-data.md `...` tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/event-data.md ...	+1/-1
version-5.2.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.2.md ...	+1/-1
optimise-cache.md `...` tyk-docs/content/basic-config-and-security/reduce-latency/caching/optimise-cache.md ...	+1/-1
quick-start.md `...` tyk-docs/content/deployment-and-operations/tyk-open-source-api-gateway/quick-start.md ...	+1/-1
gateway.md `...` tyk-docs/content/basic-config-and-security/security/gateway.md ...	+1/-1
version-4.1.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-4.1.md ...	+1/-1
version-4.1.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-4.1.md ...	+1/-1
operator-1.0.md `...` tyk-docs/content/product-stack/tyk-operator/release-notes/operator-1.0.md ...	+1/-1
tyk-operator.md `...` tyk-docs/content/tyk-operator.md ...	+1/-1
configuration.md `...` tyk-docs/content/apim-best-practice/api-security-best-practice/configuration.md ...	+1/-1
version-4.0.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-4.0.md ...	+1/-1
version-4.2.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/version-4.2.md ...	+1/-1
version-4.2.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-4.2.md ...	+1/-1
version-2.7.md `...` tyk-docs/content/product-stack/tyk-gateway/release-notes/archived-releases/version-2.7.md ...	+1/-1
tyk-stack.md `...` tyk-docs/content/tyk-stack.md ...	+1/-1
version-2.7.md `...` tyk-docs/content/product-stack/tyk-dashboard/release-notes/archived-releases/version-2.7.md ...	+1/-1
otel_jaeger_k8s.md `...` tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/distributed-tracing/open-telemetry/otel_jaeger_k8s.md ...	+1/-1
self-managed-licensing-include.md `...` tyk-docs/content/shared/self-managed-licensing-include.md ...	+1/-1
overview.md `...` tyk-docs/content/developer-support/upgrading-tyk/deployment-model/self-managed/overview.md ...	+1/-1
deploy-plugins.md `...` tyk-docs/content/plugins/get-started-selfmanaged/deploy-plugins.md ...	+1/-1
grpc-proxy.md `...` tyk-docs/content/key-concepts/grpc-proxy.md ...	+1/-1
dashboard-config.md `...` tyk-docs/content/shared/dashboard-config.md ...	+1/-1
open-source.md `...` tyk-docs/content/developer-support/upgrading-tyk/deployment-model/open-source.md ...	+1/-1
upgrading-tyk.md `...` tyk-docs/content/upgrading-tyk.md ...	+1/-1
upgrade-hybrid.md `...` tyk-docs/content/developer-support/upgrading-tyk/deployment-model/cloud/upgrade-hybrid.md ...	+1/-1
getting-started.md `...` tyk-docs/content/tyk-dashboard/getting-started.md ...	+1/-1
api-def-uptime.md `...` tyk-docs/content/shared/api-def-uptime.md ...	+1/-1
tyk-oss-gateway.md `...` tyk-docs/content/tyk-oss-gateway.md ...	+1/-1
quickstart.md `...` tyk-docs/content/plugins/tutorials/quick-starts/go/quickstart.md ...	+1/-1

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

netlify · 2024-11-16T05:20:57Z

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

Name	Link
🔨 Latest commit	`0add7e3`
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/67426012d51bbb0008ccf9ee
😎 Deploy Preview	https://deploy-preview-5727--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

* add internal hash validation --------- Co-authored-by: itachi sasuke <[email protected]> Co-authored-by: Sharad Regoti <[email protected]>

* preserve fragments code in aliases --------- Co-authored-by: itachi sasuke <[email protected]> Co-authored-by: Master <[email protected]>

external oauth Co-authored-by: Master <[email protected]>

Co-authored-by: Master <[email protected]>

* Adding docs for EDP PORTAL_RESPONSE_HEADERS

* fixes

* EDP Adding PORTAL_DISABLE_CSRF_CHECK config

github-actions · 2024-11-24T17:40:13Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Content Removal Significant content removal in the menu structure may affect existing user navigation and documentation accessibility. Ensure that these changes are intentional and communicated to users to avoid confusion. New Content Addition New entries added to the menu need to be reviewed for accuracy, relevance, and proper integration into the existing structure. This includes checking for correct paths and ensuring they do not lead to dead links. Alias Changes The updates to aliases should be carefully reviewed to ensure they correctly redirect to the intended new locations, avoiding potential 404 errors and improving user experience.

github-actions · 2024-11-24T17:41:11Z

PR Code Suggestions ✨

No code suggestions found for the PR.

sharadregoti · 2025-01-14T06:14:09Z

Closing this PR. Changes included in this PR #5823

update migration to tyk

66fb552

DavidRollins and others added 28 commits November 16, 2024 22:45

save progress

192b7d9

Save progress

57d054c

Save progress

659b84e

update migration to tyk

7fe2b3d

update migration to tyk

ac06ea0

update

4f84228

update

12013a2

update

a350d39

update

96e6764

fix pipeline

d533a10

fix pipeline

8c6628f

try one more time with this link

7afc7a3

remove private spaces link

35a9206

[DX-1770]add internal hash validation (#5725)

0c59aca

* add internal hash validation --------- Co-authored-by: itachi sasuke <[email protected]> Co-authored-by: Sharad Regoti <[email protected]>

[DX-1769] preserve section in aliases redirection (#5724)

a5127fd

* preserve fragments code in aliases --------- Co-authored-by: itachi sasuke <[email protected]> Co-authored-by: Master <[email protected]>

[DX-1771]Update docs with deprecation advice (#5729)

a6459bd

external oauth Co-authored-by: Master <[email protected]>

TT-8252 Aurora Postgresql support (#5715)

e3eabf7

Co-authored-by: Master <[email protected]>

Adding docs for EDP PORTAL_RESPONSE_HEADERS (#5736)

f645630

* Adding docs for EDP PORTAL_RESPONSE_HEADERS

Docs Fixes (#5735)

db1a0de

* fixes

DX-1773 EDP Adding PORTAL_DISABLE_CSRF_CHECK config (#5744)

882268e

* EDP Adding PORTAL_DISABLE_CSRF_CHECK config

update links after merge

3cbf877

update links after merge

3473fcb

update links after merge

8bc58f2

update links after merge

750e992

update migration page to fix heading structure

59c21da

fix aliases and delete their redundant pages

0701ae1

stash changes for merge

b338eb1

merge

e6d5f5e

DavidRollins added 22 commits November 23, 2024 00:13

update internal links in migration page - save progress

05262b8

update internal links in migration page - save progress

2718535

update the menu yaml

018a160

update the menu yaml

68ba7a5

update the menu yaml

6f178ce

update the menu yaml

c6ee7f4

update the menu yaml

fec2974

update the menu yaml

54fa3ca

update the menu yaml

8bd2658

update the menu yaml

6d61c05

update the menu yaml

1b42315

update the menu yaml

9599caf

update the menu yaml

e6c17eb

update the menu yaml

8391b8c

update the links

27c07aa

update the links

7cc97c7

update the links

b73e7e3

update the links

4f69b4c

update the links

ac7386f

update the links

c21c0d6

update the links

1245123

update menu.yaml for deleted pages

0add7e3

DavidRollins marked this pull request as ready for review November 24, 2024 17:37

github-actions bot added the Review effort [1-5]: 4 label Nov 24, 2024

sharadregoti changed the title ~~update migration to tyk~~ New IA - Migration to Tyk Nov 26, 2024

sharadregoti added the New IA Project label Nov 26, 2024

sharadregoti closed this Jan 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New IA - Migration to Tyk #5727

New IA - Migration to Tyk #5727

DavidRollins commented Nov 16, 2024 •

edited by github-actions bot

Loading

netlify bot commented Nov 16, 2024 •

edited

Loading

github-actions bot commented Nov 24, 2024

github-actions bot commented Nov 24, 2024

sharadregoti commented Jan 14, 2025

New IA - Migration to Tyk #5727

New IA - Migration to Tyk #5727

Conversation

DavidRollins commented Nov 16, 2024 • edited by github-actions bot Loading

User description

For internal users - Please add a Jira DX PR ticket to the subject!

Preview Link

Description

Screenshots (if appropriate)

Checklist

PR Type

Description

Changes walkthrough 📝

netlify bot commented Nov 16, 2024 • edited Loading

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

github-actions bot commented Nov 24, 2024

PR Reviewer Guide 🔍

github-actions bot commented Nov 24, 2024

PR Code Suggestions ✨

sharadregoti commented Jan 14, 2025

DavidRollins commented Nov 16, 2024 •

edited by github-actions bot

Loading

netlify bot commented Nov 16, 2024 •

edited

Loading